Struct grin_core::ser::BinReader

pub struct BinReader<'a, R: Read> { /* private fields */ }

Utility to read from a binary source

Implementations

impl<'a, R: Read> BinReader<'a, R>

pub fn new( source: &'a mut R, version: ProtocolVersion, mode: DeserializationMode ) -> Self

Constructor for a new BinReader for the provided source and protocol version.

Trait Implementations

impl<'a, R: Read> Reader for BinReader<'a, R>

Utility wrapper for an underlying byte Reader. Defines higher level methods to read numbers, byte vectors, hashes, etc.

fn read_bytes_len_prefix(&mut self) -> Result<Vec<u8>, Error>

Read a variable size vector from the underlying Read. Expects a usize

fn read_fixed_bytes(&mut self, len: usize) -> Result<Vec<u8>, Error>

Read a fixed number of bytes.

fn deserialization_mode(&self) -> DeserializationMode

The mode this reader is reading from

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

Read a u8 from the underlying Read

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

Read a u16 from the underlying Read

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

Read a u32 from the underlying Read

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

Read a i32 from the underlying Read

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

Read a u64 from the underlying Read

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

Read a i64 from the underlying Read

fn expect_u8(&mut self, val: u8) -> Result<u8, Error>

Consumes a byte from the reader, producing an error if it doesn’t have the expected value

fn protocol_version(&self) -> ProtocolVersion

Access to underlying protocol version to support version specific deserialization logic.

fn read_empty_bytes(&mut self, length: usize) -> Result<(), Error>

Read a fixed number of “empty” bytes from the underlying reader. It is an error if any non-empty bytes encountered.