Struct Decoder

pub struct Decoder { /* private fields */ }

Decoder for the Advanced Navigation Packet Protocol.

Implementations

impl Decoder

pub const DEFAULT_DECODER_BUFFER_SIZE: usize = 512usize

The buffer size used when not compiled with the std feature flag.

pub fn new() -> Decoder

Create a new Decoder.

pub fn bytes_in_buffer(&self) -> usize

How many bytes are in the Decoder’s internal buffer?

pub fn remaining_capacity(&self) -> usize

The amount of data that can be added to the Decoder’s internal buffer before it will become full.

Note

When compiled with the std feature the buffer is considered effectively infinite.

pub fn clear(&mut self)

Clear the Decoder’s internal buffer.

pub fn push_data(&mut self, data: &[u8]) -> Result<(), InsufficientCapacity>

Try to add some more raw data to the Decoder’s internal buffer.

pub fn decode(&mut self) -> Result<Packet, DecodeError>

Retrieve the next Packet from the Decoder’s internal buffer.

Trait Implementations

impl Clone for Decoder

fn clone(&self) -> Decoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Decoder

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

Formats the value using the given formatter.

impl Default for Decoder

fn default() -> Decoder

Returns the “default value” for a type.

impl PartialEq for Decoder

fn eq(&self, other: &Decoder) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Decoder