rust_unixfs::file::visit

Struct IdleFileVisit

Source 
pub struct IdleFileVisit { /* private fields */ }
Expand description

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§

Source§

impl IdleFileVisit

Source

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.

Source

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§

Source§

impl Debug for IdleFileVisit

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IdleFileVisit

Source§

fn default() -> IdleFileVisit

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.