Trait Reader 

pub trait Reader {
    // Required method
    fn read(&mut self, bytes: &mut [u8]) -> Result<(), DecodeError>;

    // Provided methods
    fn read_u8(&mut self) -> Result<u8, DecodeError> { ... }
    fn read_u16(&mut self) -> Result<u16, DecodeError> { ... }
    fn read_u32(&mut self) -> Result<u32, DecodeError> { ... }
    fn read_u64(&mut self) -> Result<u64, DecodeError> { ... }
    fn read_u128(&mut self) -> Result<u128, DecodeError> { ... }
    fn peek_read(&mut self, _: usize) -> Option<&[u8]> { ... }
    fn consume(&mut self, _: usize) { ... }
    fn peek_u8(&mut self) -> Option<u8> { ... }
}

A reader for owned data. See the module documentation for more information.

Required Methods

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

Fill the given bytes argument with values. Exactly the length of the given slice must be filled, or else an error must be returned.

Errors

Returns DecodeError::UnexpectedEnd if the reader does not have enough bytes.

Provided Methods

fn read_u8(&mut self) -> Result<u8, DecodeError>

Read a single byte from the reader.

Errors

Returns an error if the operation fails.

fn read_u16(&mut self) -> Result<u16, DecodeError>

Read a u16 from the reader.

Errors

Returns an error if the operation fails.

fn read_u32(&mut self) -> Result<u32, DecodeError>

Read a u32 from the reader.

Errors

Returns an error if the operation fails.

fn read_u64(&mut self) -> Result<u64, DecodeError>

Read a u64 from the reader.

Errors

Returns an error if the operation fails.

fn read_u128(&mut self) -> Result<u128, DecodeError>

Read a u128 from the reader.

Errors

Returns an error if the operation fails.

fn peek_read(&mut self, _: usize) -> Option<&[u8]>

If this reader wraps a buffer of any kind, this function lets callers access contents of the buffer without passing data through a buffer first.

fn consume(&mut self, _: usize)

If an implementation of peek_read is provided, an implementation of this function must be provided so that subsequent reads or peek-reads do not return the same bytes

fn peek_u8(&mut self) -> Option<u8>

Returns the next byte without consuming it.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl<R> Reader for BufReader<R>

where R: Read,

Available on crate feature std only.

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

fn peek_read(&mut self, n: usize) -> Option<&[u8]>

fn consume(&mut self, n: usize)

impl<T> Reader for &mut T

where T: Reader,

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

fn peek_read(&mut self, n: usize) -> Option<&[u8]>

fn consume(&mut self, n: usize)

fn read_u16(&mut self) -> Result<u16, DecodeError>

fn read_u32(&mut self) -> Result<u32, DecodeError>

fn read_u64(&mut self) -> Result<u64, DecodeError>

fn read_u128(&mut self) -> Result<u128, DecodeError>

Implementors

impl<'storage> Reader for SliceReader<'storage>

impl<R> Reader for IoReader<R>

where R: Read,

Available on crate feature std only.