Struct MovableEntryHandleReader 

pub struct MovableEntryHandleReader { /* private fields */ }

Available on crate features blocking and zip only.

An io::Read that owns its MovableEntryHandle.

Implementations

impl MovableEntryHandleReader

pub fn new( owner: MovableEntryHandle, dependent_builder: impl for<'_q> FnOnce(&'_q MovableEntryHandle) -> Box<dyn Read + '_q>, ) -> Self

Constructs a new self-referential struct.

The provided owner will be moved into a heap allocated box. Followed by construction of the dependent value, by calling dependent_builder with a shared reference to the owner that remains valid for the lifetime of the constructed struct.

pub fn try_new<Err>( owner: MovableEntryHandle, dependent_builder: impl for<'_q> FnOnce(&'_q MovableEntryHandle) -> Result<Box<dyn Read + '_q>, Err>, ) -> Result<Self, Err>

Constructs a new self-referential struct or returns an error.

Consumes owner on error.

pub fn try_new_or_recover<Err>( owner: MovableEntryHandle, dependent_builder: impl for<'_q> FnOnce(&'_q MovableEntryHandle) -> Result<Box<dyn Read + '_q>, Err>, ) -> Result<Self, (MovableEntryHandle, Err)>

Constructs a new self-referential struct or returns an error.

Returns owner and error as tuple on error.

pub fn borrow_owner<'_q>(&'_q self) -> &'_q MovableEntryHandle

Borrows owner.

pub fn with_dependent<'outer_fn, Ret>( &'outer_fn self, func: impl for<'_q> FnOnce(&'_q MovableEntryHandle, &'outer_fn Box<dyn Read + '_q>) -> Ret, ) -> Ret

Calls given closure func with a shared reference to dependent.

pub fn with_dependent_mut<'outer_fn, Ret>( &'outer_fn mut self, func: impl for<'_q> FnOnce(&'_q MovableEntryHandle, &'outer_fn mut Box<dyn Read + '_q>) -> Ret, ) -> Ret

Calls given closure func with an unique reference to dependent.

pub fn borrow_dependent<'_q>(&'_q self) -> &'_q Box<dyn Read + '_q>

Borrows dependent.

pub fn into_owner(self) -> MovableEntryHandle

Consumes self and returns the the owner.

Trait Implementations

impl Drop for MovableEntryHandleReader

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Read for MovableEntryHandleReader

fn read(&mut self, buffer: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.