Struct BaseEncoder 

pub struct BaseEncoder<'a, T: Types> { /* private fields */ }

An encoder capable of emitting fountain-encoded transmissions.

Examples

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

Implementations

impl<'a> BaseEncoder<'a, Alloc>

pub const fn new() -> Self

Construct a new Encoder.

impl<'a, const MAX_FRAGMENT_LEN: usize, const MAX_SEQUENCE_COUNT: usize> BaseEncoder<'a, Heapless<MAX_FRAGMENT_LEN, MAX_SEQUENCE_COUNT>>

pub const fn new() -> Self

Constructs a new HeaplessEncoder.

impl<'a, T: Types> BaseEncoder<'a, T>

pub fn start(&mut self, message: &'a [u8], max_fragment_length: usize)

Start encoding a new message.

Panics

This function panics if:

• The message is empty.
• The maximum fragment length is zero.
• The maximum fragment length is large than what T::Data can hold.

pub fn current_sequence(&self) -> u32

Returns the current count of how many parts have been emitted.

pub fn sequence_count(&self) -> u32

Returns the number of segments the original message has been split up into.

pub fn is_complete(&self) -> bool

Returns whether all original segments have been emitted at least once. The fountain encoding is defined as doing this before combining segments with each other. Thus, this is equivalent to checking whether current_sequence >= fragment_count.

pub fn next_part(&mut self) -> Part<'_>

Returns the next part to be emitted by the fountain encoder. After all parts of the original message have been emitted once, the fountain encoder will emit the result of xor-ing together the parts selected by the Xoshiro RNG (which could be a single part).

Examples

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