Struct cjdns_bytes::Reader

pub struct Reader<'a>(_);

Buffer reader

Implementations

impl<'a> Reader<'a>

pub fn new(data: &'a [u8]) -> Self

Instantiates Reader.

pub fn read<R, F: FnOnce(&mut Self) -> Result<R, InsufficientBuffer>>(
    &mut self,
    expected_size: ExpectedSize,
    job: F
) -> Result<R, ReadError>

Reads bytes in accordance to logic implemented in job.

If expected_size check fails (i.e. readers size does not apply to expected condition), ReaderError is returned.

Panics

job closure is used to encapsulate multiple reads from Reader. Data reads in job must be infallible: they should coordinate with the expected size. So if too much than could be or less than stated in expected_size was read, it finishes with panic.

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

Reads u8

pub fn read_u16_be(&mut self) -> Result<u16, InsufficientBuffer>

Reads big endian u16

pub fn read_u32_be(&mut self) -> Result<u32, InsufficientBuffer>

Reads big endian u32

pub fn read_u64_be(&mut self) -> Result<u64, InsufficientBuffer>

Reads big endian u64

pub fn read_array_32(&mut self) -> Result<[u8; 32], InsufficientBuffer>

Reads [u8; 32] array.

pub fn peek_remainder(&self) -> &'a [u8]

Peeks remainder without mutating readers state

pub fn read_remainder(&mut self) -> &'a [u8]

Returns remainder mutating readers state.

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

Skips count amount of data.

pub fn read_slice(
    &mut self,
    count: usize
) -> Result<&'a [u8], InsufficientBuffer>

Reads count values.

pub fn is_empty(&self) -> bool