Struct TagStructReader

pub struct TagStructReader<'a> { /* private fields */ }

A streaming reader for tagstruct-encoded data.

Implementations

impl<'a> TagStructReader<'a>

pub fn new(inner: &'a mut dyn BufRead, protocol_version: u16) -> Self

Creates a tagstruct reader from a BufRead instance.

pub fn read_tag(&mut self) -> Result<Tag, ProtocolError>

Reads a tag from the stream.

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

Reads a single byte.

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

Reads an unsigned 32-bit integer.

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

Reads an unsigned 64-bit integer.

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

Reads a signed 64-bit integer.

pub fn read_bool(&mut self) -> Result<bool, ProtocolError>

Reads a boolean value.

pub fn read_usec(&mut self) -> Result<u64, ProtocolError>

Reads a “usec” value, which is a 64-bit unsigned integer representing a number of microseconds.

pub fn read_timeval(&mut self) -> Result<SystemTime, ProtocolError>

Reads a timestamp, or “timeval”, with microsecond precision.

pub fn read_arbitrary(&mut self) -> Result<Vec<u8>, ProtocolError>

Reads an “arbitrary”, a byte blob. Allocates a vec.

pub fn read_arbitrary_unprefixed( &mut self, len: u32, ) -> Result<Vec<u8>, ProtocolError>

Reads an “arbitrary” without length prefix.

pub fn read_string(&mut self) -> Result<Option<CString>, ProtocolError>

Reads a null-terminated string (which may be a special null string tag).

Note that strings in a tagstruct aren’t necessarily encoded in UTF-8.

pub fn read_string_non_null(&mut self) -> Result<CString, ProtocolError>

Reads a null-terminated string.

pub fn read_index(&mut self) -> Result<Option<u32>, ProtocolError>

Reads a u32, and checks it against PA_INVALID_INDEX (-1).

pub fn read_enum<T: FromPrimitive>(&mut self) -> Result<T, ProtocolError>

Reads a u32 and checks that it is valid for the given enum.

pub fn read<T: TagStructRead>(&mut self) -> Result<T, ProtocolError>

Reads a value which implements TagStructRead.

pub fn has_data_left(&mut self) -> Result<bool, ProtocolError>

Returns whether there is any data left in the input stream.

Trait Implementations

impl Debug for TagStructReader<'_>

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

Formats the value using the given formatter.