Struct ipfs_unixfs::walk::Walker

pub struct Walker { /* fields omitted */ }

Walker helps with walking a UnixFS tree, including all of the content and files. It is created with Walker::new and walked over each block with Walker::continue_block. Use Walker::pending_links to obtain the next Cid to be loaded and the prefetchable links.

Implementations

impl Walker

pub fn new(cid: Cid, root_name: String) -> Walker

Returns a new instance of a walker, ready to start from the given Cid.

pub fn as_entry(&self) -> Option<Entry>

Returns a description of the kind of node the Walker is currently looking at, if continue_walk has been called after the value was created.

pub fn pending_links<'a>(
    &'a self
) -> (&'a Cid, impl Iterator<Item = &'a Cid> + 'a)

Returns the next Cid to load and pass its associated content to continue_walk.

pub fn continue_walk<'a>(
    self,
    bytes: &'a [u8],
    cache: &mut Option<Cache>
) -> Result<ContinuedWalk<'a>, Error>

Continues the walk.

Returns a descriptor for the next element found as ContinuedWalk which includes the means to further continue the walk. bytes is the raw data of the next block, cache is an optional cache for data structures which can always be substituted with &mut None.

Trait Implementations

impl Debug for Walker

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.