Enum body_image::BodyReader

pub enum BodyReader<'a> {
    Contiguous(Cursor<&'a [u8]>),
    Scattered(GatheringReader<'a, Bytes>),
    FileSlice(ReadSlice),
}

Provides a Read reference for a BodyImage in any state.

Variants

Contiguous(Cursor<&'a [u8]>)

Cursor over a contiguous single RAM buffer, from Ram or MemMap. Also used for the empty case. Cursor::into_inner may be used for direct access to the memory byte slice.

Scattered(GatheringReader<'a, Bytes>)

GatheringReader providing Read over 2 or more scattered RAM buffers.

FileSlice(ReadSlice)

ReadSlice providing instance independent, unbuffered Read and Seek for BodyImage FsRead state, limited to a range within an underlying file. Consider wrapping this in std::io::BufReader if performing many small reads.

Methods

impl<'a> BodyReader<'a>

pub fn as_read(&mut self) -> &mut dyn Read

Deprecated since 1.1.0:

BodyReader now implements Read directly

Return the Read reference.

Trait Implementations

impl<'a> Read for BodyReader<'a>

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

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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