tsarevvv/rust-ipfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
42da57f419
rust-ipfs/unixfs
History
ljedrz a9712ef740 chore: put Rust-IPFS contributors as authors 
Signed-off-by: ljedrz <ljedrz@gmail.com>
2020-08-11 15:14:43 +02:00
..
benches bench: filter symlinks earlier 2020-08-10 11:45:58 +03:00
examples refactor: remove duplicated ingest-tar example, it remains as bench 2020-08-10 09:13:44 +03:00
src doc: suggestions and notes from code review 2020-08-10 12:04:03 +03:00
Cargo.toml chore: put Rust-IPFS contributors as authors 2020-08-11 15:14:43 +02:00
CHANGELOG.md chore: changelog 2020-07-03 12:20:58 +03:00
pb-rs-gen.sh fix: remove --owned from pb-rs gen 2020-06-08 15:03:34 +03:00
README.md chore(unixfs): README, license notes, set version to 0.0.1 2020-06-18 20:24:57 +03:00

README.md

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

License

MIT or APL2.