Struct unixfs_v1::file::visit::IdleFileVisit

pub struct IdleFileVisit { /* fields omitted */ }

IdleFileVisit represents a prepared file visit over a tree. The user has to know the CID and be able to get the block for the visit.

Note: For easier to use interface, you should consider using ipfs_unixfs::walk::Walker. It uses IdleFileVisit and FileVisit internally but has a better API.

Implementations

impl IdleFileVisit

pub fn with_target_range(self, range: Range<u64>) -> Self

Target range represents the target byte range of the file we are interested in visiting.

pub fn start(
    self,
    block: &[u8]
) -> Result<(&'_ [u8], u64, Metadata, Option<FileVisit>), FileReadFailed>

Begins the visitation by processing the first block to be visited.

Returns (on success) a tuple of file bytes, total file size, any metadata associated, and optionally a FileVisit to continue the walk.

Trait Implementations

impl Debug for IdleFileVisit

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

Formats the value using the given formatter.

impl Default for IdleFileVisit

fn default() -> IdleFileVisit

Returns the “default value” for a type.