Expand description
UnixFS implementation for ferripfs, ported from Kubo’s boxo/ipld/unixfs.
This module provides:
- Chunking algorithms (size-based, rabin fingerprinting)
- DAG building (balanced, trickle layouts)
- UnixFS protobuf encoding
- File, directory, and symlink node types
Modules§
- pb
- Protobuf definitions for UnixFS and MerkleDAG
Structs§
- AddResult
- Result of adding content
- DagBuilder
- DAG builder for importing files
- DagBuilder
Options - Options for DAG building
- DirEntry
- An entry in a UnixFS directory listing.
- Link
- A link to a child node in a UnixFS DAG.
- Rabin
Chunker - Rabin fingerprint chunker for content-defined chunking.
- Size
Chunker - Size-based chunker that splits data at fixed intervals.
- Unix
FsNode - A UnixFS node representing a file, directory, or symlink.
Enums§
- Chunker
Type - Chunker type enum for configuration
- Data
Type - The type of data stored in a UnixFS node.
- Layout
- DAG layout type
- Unixfs
Error - UnixFS error type
Constants§
- DEFAULT_
CHUNK_ SIZE - Default chunk size (256 KiB)
- DEFAULT_
LINKS_ PER_ BLOCK - Maximum links per node in balanced DAG
Traits§
- Chunker
- A chunker splits data into chunks for storage.
Functions§
- add_
directory - Add a directory with entries entries: (name, cid, cumulative_size) - cumulative_size is used for link tsize
- add_
symlink - Add a symlink
- cat
- Read file content from a CID
- get
- Get a file from the blockstore and write to a path
- ls
- List directory entries
- ls_fast
- List directory entries without resolving types (faster)
- refs
- Get all block references from a CID (non-recursive)
- refs_
recursive - Get all block references recursively
- resolve_
type - Resolve the type of a CID
Type Aliases§
- Unixfs
Result - Result type for UnixFS operations