unixfs: add a directory interface #5160
Conversation
mfs/dir.go
Outdated
| @@ -363,6 +363,18 @@ func (d *Directory) AddChild(name string, nd ipld.Node) error { | |||
| return err | |||
| } | |||
|
|
|||
| //TODO: Resolve where to manage a possible transition to sharding. | |||
There was a problem hiding this comment.
This is ugly, and it's not equivalent to transitioning inside unix.io.Directory.AddChild.
mfs/dir.go
Outdated
| // TODO: Rename. Actually the real confusion is that | ||
| // this structure has a `AddChild` function that calls | ||
| // another `AddChild` function of its inner dir. | ||
| func (d *Directory) AddChildUnixFSDir(name string, nd ipld.Node) error { |
There was a problem hiding this comment.
@whyrusleeping What do you think about moving the HAMT transition to the MFS layer?
There was a problem hiding this comment.
I guess the answer to that question depends on when we will need to do this, but I think its probably fine to have it in mfs
| // It just allows to perform explicit edits on a single directory, working with | ||
| // directory trees is out of its scope, they are managed by the MFS layer | ||
| // (which is the main consumer of this interface). | ||
| type Directory interface { |
There was a problem hiding this comment.
Please review these comments and add information here.
| return nil, ErrNotADir | ||
| } | ||
|
|
||
| // SetPrefix implements the `Directory` interface. |
There was a problem hiding this comment.
I'm basically repeating "implements the Directory interface" to avoid copying the method comments of the interface (in case they are changed, DRY). I'm only commenting here particularities of each implementation. However, this doesn't seem so nice either, what's the Go idiomatic way of doing it?
There was a problem hiding this comment.
I think in go, for obvious interface implementation methods, they often just get left blank. Saying 'implements X' is fine with me too
schomatis
added
need/review
schomatis
changed the title
unixfs/io/directory.go
Outdated
| // ShardSplitThreshold specifies how large of an unsharded directory | ||
| // the Directory code will generate. Adding entries over this value will | ||
| // result in the node being restructured into a sharded object. | ||
| var ShardSplitThreshold = 1000 |
There was a problem hiding this comment.
I think this is actually unused now. We should probably remove it
unixfs/io/directory.go
Outdated
| // (which is the main consumer of this interface). | ||
| type Directory interface { | ||
|
|
||
| // SetPrefix sets the prefix of the root node. |
There was a problem hiding this comment.
i'd say "sets the cid prefix"
Add a UnixFS `Directory` that hides implementation details and helps to distinguish *what* is a UnixFS directory. Replace the `unixfs.io.Directory` structure that contained the HAMT and basic directory implementations (through inner pointers) with an interface containing the same methods. Implement those methods in two clearly distinct structures for each implementation (`BasicDirectory` and `HAMTDirectory`) avoiding pointer logic and clearly differentiating which implementation does what. The potential basic to HAMT transition was being hidden behind the `AddChild` call at the UnixFS layer (changing one implementation pointer with the other one), it is now being explicitly done at the MFS layer. Rename the `dirbuilder.go` file to `directory.go` and change the `Directory` MFS attribute `dirbuilder` to `unixfsDir` to be consistent. License: MIT Signed-off-by: Lucas Molas <schomatis@gmail.com>
ghost
added
the
License: MIT Signed-off-by: Lucas Molas <schomatis@gmail.com>
schomatis
added
RFM
and removed
status/in-progress
Addresses #5157.
Closes #5084.