tsarevvv/rust-ipfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update README.md

Browse Source
This commit is contained in:
Joonas Koivunen 2020-08-14 15:47:20 +03:00
parent 2a68d04a81
commit b495c57a1f
1 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
unixfs/README.md
View File

@ -8,21 +8,11 @@
## 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
* unfiltered walking of known unixfs trees
* creation of balanced file trees
* creation of non HAMT-sharded directory trees
## 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`
See the docs at https://docs.rs/ipfs-unixfs.
## License