Struct foundation_ur::BaseDecoder

pub struct BaseDecoder<T: Types> { /* private fields */ }

A uniform resource decoder able to receive URIs that encode a fountain part.

Examples

See the crate module documentation for an example.

Implementations

impl<const MAX_MESSAGE_LEN: usize, const MAX_MIXED_PARTS: usize, const MAX_FRAGMENT_LEN: usize, const MAX_SEQUENCE_COUNT: usize, const QUEUE_SIZE: usize, const MAX_UR_TYPE: usize> BaseDecoder<Heapless<MAX_MESSAGE_LEN, MAX_MIXED_PARTS, MAX_FRAGMENT_LEN, MAX_SEQUENCE_COUNT, QUEUE_SIZE, MAX_UR_TYPE>>

pub const fn new() -> Self

Construct a new HeaplessDecoder.

impl<T: Types> BaseDecoder<T>

pub fn receive<'a>(&mut self, ur: UR<'_>) -> Result<(), Error>

Receives a URI representing a CBOR and bytewords-encoded fountain part into the decoder.

Examples

See the crate module documentation for examples.

Errors

This function may error along all the necessary decoding steps:

• The string may not be a well-formed URI according to the uniform resource scheme
• The URI payload may not be a well-formed bytewords string
• The decoded byte payload may not be valid CBOR
• The CBOR-encoded fountain part may be inconsistent with previously received ones

In all these cases, an error will be returned.

pub fn is_complete(&self) -> bool

Returns whether the decoder is complete and hence the message available.

Examples

See the crate module documentation for an example.

pub fn ur_type(&self) -> Option<&str>

Returns the UR type.

pub fn message(&self) -> Result<Option<&[u8]>, Error>

If complete, returns the decoded message, None otherwise.

Errors

If an inconsistent internal state is detected, an error will be returned.

Examples

See the crate documentation for an example.

pub fn estimated_percent_complete(&self) -> f64

Calculate estimated percentage of completion.

pub fn is_empty(&self) -> bool

Returns true if the decoder doesn’t contain any data.

Once a part is successfully received this method will return false.

Examples

let decoder: HeaplessDecoder<8, 8, 8, 8, 8> = HeaplessDecoder::new();
assert!(decoder.is_empty());

pub fn clear(&mut self)

Clear the decoder so that it can be used again.

Trait Implementations

impl<T: Default + Types> Default for BaseDecoder<T>

where T::Decoder: Default, T::Fragment: Default, T::URType: Default,

fn default() -> BaseDecoder<T>

Returns the “default value” for a type.