Struct tarrasque::Stream

pub struct Stream<'a>(pub &'a [u8]);

A stream of bytes from which values can be extracted.

Tuple Fields

0: &'a [u8]

Implementations

impl<'a> Stream<'a>

pub fn extract<T, P>(&mut self, parameter: P) -> ExtractResult<'a, T>where
    T: Extract<'a, P>,

Extracts bytes from this stream as a T.

Example

let mut stream = Stream(&[1, 2]);
assert_eq!(stream.extract::<u8, _>(()), Ok(0x01));
assert_eq!(stream.extract::<u8, _>(()), Ok(0x02));
assert_eq!(stream.extract::<u8, _>(()), Err(ExtractError::Insufficient(1)));

pub fn peek<T, P>(&mut self, parameter: P) -> ExtractResult<'a, T>where
    T: Extract<'a, P>,

Returns bytes from this stream as a T without extracting the bytes.

Example

let mut stream = Stream(&[1, 2, 3, 4]);
assert_eq!(stream.peek::<u16, _>(()), Ok(0x0102));
assert_eq!(stream.extract::<u16, _>(()), Ok(0x0102));
assert_eq!(stream.peek::<u16, _>(()), Ok(0x0304));
assert_eq!(stream.extract::<u16, _>(()), Ok(0x0304));
assert_eq!(stream.peek::<u16, _>(()), Err(ExtractError::Insufficient(2)));
assert_eq!(stream.extract::<u16, _>(()), Err(ExtractError::Insufficient(2)));

pub fn skip(&mut self, n: usize)

Skips the supplied number of bytes in this stream.

Example

let mut stream = Stream(&[1, 2, 3, 4]);
stream.skip(2);
assert_eq!(stream.extract::<u16, _>(()), Ok(0x0304));
assert_eq!(stream.extract::<u16, _>(()), Err(ExtractError::Insufficient(2)));

pub fn skip_while<F: Fn(u8) -> bool>(&mut self, f: F)

Skips bytes in this stream while the supplied condition is true for those bytes.

Example

let mut stream = Stream(&[1, 2, 3, 4]);
stream.skip_while(|b| b < 3);
assert_eq!(stream.extract::<u16, _>(()), Ok(0x0304));
assert_eq!(stream.extract::<u16, _>(()), Err(ExtractError::Insufficient(2)));

Trait Implementations

impl<'a> Clone for Stream<'a>

fn clone(&self) -> Stream<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Stream<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> PartialEq<Stream<'a>> for Stream<'a>

fn eq(&self, other: &Stream<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for Stream<'a>

impl<'a> Eq for Stream<'a>

impl<'a> StructuralEq for Stream<'a>

impl<'a> StructuralPartialEq for Stream<'a>