Struct grin_core::ser::StreamingReader

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

A reader that reads straight off a stream. Tracks total bytes read so we can verify we read the right number afterwards.

Implementations

impl<'a> StreamingReader<'a>

pub fn new(
    stream: &'a mut dyn Read,
    version: ProtocolVersion
) -> StreamingReader<'a>

Create a new streaming reader with the provided underlying stream. Also takes a duration to be used for each individual read_exact call.

pub fn total_bytes_read(&self) -> u64

Returns the total bytes read via this streaming reader.

Trait Implementations

impl<'a> Reader for StreamingReader<'a>

Note: We use read_fixed_bytes() here to ensure our "async" I/O behaves as expected.

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 read_bytes_len_prefix(&mut self) -> Result<Vec<u8>, Error>

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

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

Read a fixed number of bytes.

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.