Trait musli_binary_common::reader::Reader

pub trait Reader<'de> {
    type Error: Error;

    fn pos(&self) -> Option<usize>;
    fn skip(&mut self, n: usize) -> Result<(), Self::Error>;
    fn read_bytes(&mut self, n: usize) -> Result<&'de [u8], Self::Error>;

    fn read(&mut self, buf: &mut [u8]) -> Result<(), Self::Error> { ... }
    fn read_byte(&mut self) -> Result<u8, Self::Error> { ... }
    fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Self::Error> { ... }
    fn with_position(self) -> WithPosition<Self>
    where
        Self: Sized,
    { ... }
}

Trait governing how a source of bytes is read.

This requires the reader to be able to hand out contiguous references to the byte source through Reader::read_bytes.

Required Associated Types

type Error: Error

Error type raised by the current reader.

Required Methods

fn pos(&self) -> Option<usize>

The position of the reader.

fn skip(&mut self, n: usize) -> Result<(), Self::Error>

Skip over the given number of bytes.

fn read_bytes(&mut self, n: usize) -> Result<&'de [u8], Self::Error>

Read a slice out of the current reader.

Provided Methods

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

Read a slice into the given buffer.

fn read_byte(&mut self) -> Result<u8, Self::Error>

Read a single byte.

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

Read an array out of the current reader.

fn with_position(self) -> WithPosition<Self> where
    Self: Sized, 

Keep an accurate record of the position within the reader.

Implementations on Foreign Types

impl<'de> Reader<'de> for &'de [u8]

type Error = SliceReaderError

fn pos(&self) -> Option<usize>

fn skip(&mut self, n: usize) -> Result<(), Self::Error>

fn read_bytes(&mut self, n: usize) -> Result<&'de [u8], Self::Error>

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

impl<'de, R> Reader<'de> for &mut R where
    R: ?Sized + Reader<'de>, 

type Error = <R as Reader<'de>>::Error

fn pos(&self) -> Option<usize>

fn skip(&mut self, n: usize) -> Result<(), Self::Error>

fn read_bytes(&mut self, n: usize) -> Result<&'de [u8], Self::Error>

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

fn read_byte(&mut self) -> Result<u8, Self::Error>

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

Implementors

impl<'de, R> Reader<'de> for WithPosition<R> where
    R: Reader<'de>, 

type Error = <R as Reader<'de>>::Error