Joonas Koivunen 3bfa506f69 refactor: suggestions from code review

Including mostly comment fixes and removal of an extra &mut.

Co-authored-by: ljedrz <ljedrz@users.noreply.github.com>

2020-06-17 17:27:05 +03:00

ipfs-unixfs

Goals:

blockstore API independent way to traverse the merkledag
- the core read API does not deal with loading blocks
- instead access to interesting Cids is given

Status:

first iteration of file reader has been implemented
first iteration of resolving IpfsPath segments through directories has been implemented
- as the HAMTShard structure is not fully understood, all buckets are searched, however the API is expected to remain the same even if more efficient lookup is implemented
first iteration of /get-like tree walking implemented
creation and alteration of dags has not been implemented

Usage:

The main entry point to walking anything unixfs should be ipfs_unixfs::walk::Walker
The main entry point to resolving links under dag-pb or unixfs should be ipfs_unixfs::resolve
There is a ipfs_unixfs::file::visit::FileVisit utility but it should be considered superceded by ipfs_unixfs::walk::Walker