Struct BaseEncoder 

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

A uniform resource encoder with an underlying fountain encoding.

Examples

See the crate documentation for an example.

Implementations

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

pub const fn new() -> Self

Construct a new Encoder.

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

pub const fn new() -> Self

Construct a new HeaplessEncoder.

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

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

Creates a new encoder for the given message payload.

The emitted fountain parts will respect the maximum fragment length argument.

Examples

See the crate documentation for an example.

Panics

This function panics if ur_type or message is empty, or if max_fragment_length is zero.

pub fn current_sequence(&self) -> u32

Returns the current count of already emitted parts.

Examples

encoder.start("bytes", "data".as_bytes(), 5);

assert_eq!(encoder.current_sequence(), 0);
encoder.next_part();
assert_eq!(encoder.current_sequence(), 1);

pub fn sequence_count(&self) -> u32

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

Examples

encoder.start("bytes", "data".as_bytes(), 3);
assert_eq!(encoder.sequence_count(), 2);

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

Returns the URI corresponding to next fountain part.

Examples

See the crate documentation for an example.