Struct stream_inmemory::Stream

pub struct Stream { /* fields omitted */ }

Dynamically sized inmemory stream.

Used as buffer with read, write and peek funcs.

Implementations

impl Stream

pub fn new() -> Stream

Create new Stream with zero capacity.

pub fn peek_byte(&self) -> Result<u8, StreamError>

Peek one byte from stream, position don’t shift.

Can return EOF error.

pub fn peek(&self, buffer: &mut [u8]) -> Result<usize, StreamError>

Peek bytes from stream, position don’t shift.

Can return EOF, ZeroLength errors.

pub fn read_byte(&mut self) -> Result<u8, StreamError>

Read one byte from stream, position shifted.

Can return EOF error.

pub fn read(&mut self, buffer: &mut [u8]) -> Result<usize, StreamError>

Read bytes from stream, position shifted.

Can return EOF, ZeroLength errors.

pub fn write_byte(&mut self, byte: u8)

Write one byte to stream.

pub fn write(&mut self, buffer: &[u8]) -> usize

Write bytes to stream.

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

Skip “count” bytes in stream. Return skipped bytes count.

pub fn skip_all(&mut self) -> usize

Skip all bytes in stream. Return skipped bytes count.

pub fn view(&self) -> &[u8]

View of available bytes in stream.

pub fn truncate_readied(&mut self)

Clear bytes that have been read. Has no effect on the allocated capacity.

pub fn truncate_capacity(&mut self)

Truncate the capacity of the stream as much as possible.

pub fn available(&self) -> usize

Return available to read bytes.