Struct il2_iltags::io::LimitedReader

pub struct LimitedReader<'a> { /* fields omitted */ }

The LimitedReader implements a Reader that wraps another Reader but defines a limited to the amount of bytes that can be extracted from it.

This wrapper was designed to ease the implementation of the deserialization of the tags.

It is important to notice that LimitedReader will test the limits prior to the attempt to read the data, thus failed attempts will not consume data from the inner reader.

Implementations

impl<'a> LimitedReader<'a>

pub fn new(src: &mut dyn Reader, available: usize) -> LimitedReader<'_>

Creates a new instance of this struct.

Parameters:

• src: A mutable reference to the source Reader.
• available: Number of bytes available for reading.

pub fn can_read(&self, size: usize) -> Result<()>

Verifies if it is possible to extract a given number of bytes from the source.

Parameters:

• size: The number of bytes to read.

Returns:

• Ok(()): On success.
• Err(ErrorKind): If the specified number of bytes is not available.

pub fn available(&self) -> usize

Returns the number of available bytes.

Returns:

• The number of available bytes.

pub fn goto_end(&mut self) -> Result<()>

Skips the required number of bytes required to achive the end of the specified limit.

Returns:

• Ok(()): On success.
• Err(ErrorKind): If the specified number of bytes is not available.

pub fn empty(&self) -> bool

Verifies if the this reader is empty.

Returns:

• true: if it is empty;
• false: if it is not empty;

Trait Implementations

impl<'a> Reader for LimitedReader<'a>

fn read(&mut self) -> Result<u8>

Reads a single byte from the source.

fn read_all(&mut self, buff: &mut [u8]) -> Result<()>

Reads the specified number of bytes from the source.

fn skip(&mut self, count: usize) -> Result<()>

Skips some bytes from the source.