Struct BaseDecoder 

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

A decoder capable of receiving and recombining fountain-encoded transmissions.

Examples

See the crate::fountain 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> BaseDecoder<Heapless<MAX_MESSAGE_LEN, MAX_MIXED_PARTS, MAX_FRAGMENT_LEN, MAX_SEQUENCE_COUNT, QUEUE_SIZE>>

pub const fn new() -> Self

Constructs a new HeaplessDecoder.

impl<T: Types> BaseDecoder<T>

pub fn receive(&mut self, part: &Part<'_>) -> Result<bool, Error>

Receives a fountain-encoded part into the decoder.

Examples

See the crate::fountain module documentation for an example.

Errors

If the part would fail validate because it is inconsistent with previously received parts, an error will be returned.

pub fn is_part_consistent(&self, part: &Part<'_>) -> bool

Checks whether a Part is receivable by the decoder.

This can fail if other parts were previously received whose metadata (such as number of segments) is inconsistent with the present Part. Note that a fresh decoder will always return false here.

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::fountain module documentation for an example.

pub fn is_complete(&self) -> bool

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

Examples

See the crate::fountain module 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.

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::Message: Default, T::MixedParts: Default, T::Indexes: Default, T::Queue: Default, T::Chooser: Default,

fn default() -> BaseDecoder<T>

Returns the “default value” for a type.