Struct ipfs_unixfs::file::reader::FileReader

pub struct FileReader<'a> { /* fields omitted */ }

Navigates the UnixFs files, which are either:

• single block files which have everything needed to all of the contents
• multi block files which have trees of trees until Raw leaf blocks

The trees can have different shapes but it doesn't really matter for our depth-first approach. For seeking, the each sub-tree linking node will have blocksizes for the trees representing which the original file offsets covered by the tree.

A file doesn't know it's name. It only has a name when part of a directory, and then the name is on a PbLink::Name. With UnixFs the names are always UTF-8. The root CID is not interesting either: we just need the root block.

Implementations

impl<'a> FileReader<'a>

pub fn from_block(data: &'a [u8]) -> Result<Self, FileReadFailed>

Method for starting the file traversal. data is the raw data from unixfs block.

pub fn content(
    self
) -> (FileContent<'a, impl Iterator<Item = (PBLink<'a>, Range<u64>)>>, Traversal)

Returns a moved tuple of the content (bytes or links) and a traversal, which can be used to continue the traversal from the next block.

pub fn file_size(&self) -> u64

Returns the total size of the file.

Trait Implementations

impl<'_> AsRef<Metadata> for FileReader<'_>

fn as_ref(&self) -> &Metadata

Performs the conversion.