Struct Reader 

pub struct Reader<'a> {
    flash: &'a dyn Flash,
    buffer: &'a mut [u8],
    loaded: Option<u64>,
    checked: bool,
    blocks: GoodBlocks<'a>,
    next_index: u64,
    current: Option<u32>,
    position: u64,
}

Reader over the good blocks of an MTD device.

Bad blocks are skipped, so the data of good block n starts at byte n * block_size. Errors are DeviceErrors wrapped in io::Error. A block with uncorrectable ECC errors fails the read, unless the reader was created with Reader::unchecked.

The reader loads one whole block at a time into the buffer of the caller and serves reads from it. io::BufRead gives access to that buffer.

Fields

flash: &'a dyn Flash

buffer: &'a mut [u8]

Buffer for the data of one block.

loaded: Option<u64>

Index of the good block in buffer.

checked: bool

Whether loading a block checks for uncorrectable ECC errors.

blocks: GoodBlocks<'a>

Good blocks after current.

next_index: u64

Index of the good block that blocks yields next.

current: Option<u32>

Physical index of good block next_index - 1.

position: u64

Implementations

impl<'a> Reader<'a>

pub fn new( flash: &'a dyn Flash, buffer: &'a mut [u8], ) -> Result<Self, DeviceError>

Creates a reader over all good blocks of flash.

buffer must be exactly one block long.

Errors

Returns DeviceError::BufferLength if buffer isn’t one block long.

pub fn unchecked( flash: &'a dyn Flash, buffer: &'a mut [u8], ) -> Result<Self, DeviceError>

Creates a reader that skips the ECC check.

Blocks with uncorrectable ECC errors return their data with the bit errors. Use this if you verify the data yourself, for example with a checksum. The ECC check reads the ECC statistics twice per block. On kernels with CONFIG_MTD_LAZYECCSTATS, each of those reads checks the bad block marker of every block in the partition.

Errors

Returns DeviceError::BufferLength if buffer isn’t one block long.

fn with_check( flash: &'a dyn Flash, buffer: &'a mut [u8], checked: bool, ) -> Result<Self, DeviceError>

pub fn size(&self) -> Result<u64, DeviceError>

Returns the number of readable bytes: the size of all good blocks.

Errors

Returns an error if the bad block markers can’t be read.

fn locate(&mut self, index: u64) -> Result<Option<u32>, DeviceError>

Returns the physical index of good block index, or None if there are fewer good blocks.

fn restart(&mut self)

Trait Implementations

impl BufRead for Reader<'_>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amount: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Checks if there is any data left to be read.

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

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl Debug for Reader<'_>

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

Formats the value using the given formatter.

impl Read for Reader<'_>

fn read(&mut self, buf: &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<'_, u8>) -> 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<'_, u8>, ) -> 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.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order.

impl Seek for Reader<'_>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.