Skip to main content

ContinuousDecoder

Struct ContinuousDecoder 

Source
pub struct ContinuousDecoder<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> { /* private fields */ }
Expand description

Stateful, bounded RFC 8681 decoder and ordered CopperList assembler.

Recovered records are delivered to the caller immediately and are never retained in an ever-growing history. Exact gap reporting assumes the sender serializes CopperLists in increasing identifier order, as generated Copper runtimes do. Assembly buffers grow on demand up to receiver limits and are recycled after delivery or expiry. Once buffer sizes and concurrency have warmed up, record assembly and borrowed delivery need no heap allocations.

Implementations§

Source§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>

Source

pub fn new( identity: StreamIdentity, lane: Lane, config: RlcConfig, equation_capacity: usize, first_object_id: u64, limits: ReceiverLimits, ) -> Result<Self>

Source

pub fn enable_feedback(&mut self)

Enable bounded finalized-loss accounting on the receiver worker.

Source

pub fn source_outcomes(&self) -> SourceOutcomes

Source

pub const fn next_object_id(&self) -> u64

Source

pub const fn stats(&self) -> ContinuousRecoveryStats

Source

pub fn occupancy(&self) -> ReceiverOccupancy

Source

pub fn drain_events<E>( &mut self, emit: impl FnMut(ContinuousReceiveEvent<'_>) -> Result<(), E>, ) -> Result<(), ReceiveError<E>>

Retries delivery of ordered records or gaps already ready in receiver state.

This is useful after a consumer error and when shutting down a transport after its final datagram. A consumer failure leaves the current event pending so a later call can retry it.

Source

pub fn finish_through<E>( &mut self, last_object_id: u64, emit: impl FnMut(ContinuousReceiveEvent<'_>) -> Result<(), E>, ) -> Result<(), ReceiveError<E>>

Finalizes ordered delivery through an inclusive CopperList identifier.

Any unresolved record or wholly absent identifier through last_object_id is emitted as a terminal gap. Calling this method is an explicit promise that no more useful repair symbols for that range will arrive.

Source

pub fn receive_datagram<E>( &mut self, datagram: &[u8], emit: impl FnMut(ContinuousReceiveEvent<'_>) -> Result<(), E>, ) -> Result<(), ReceiveError<E>>

Validates and submits one carrier-verified datagram. Malformed or foreign packets are counted and ignored before they can contaminate the FEC decoder. Recovered records and definitive gaps are emitted in CopperList-id order. Callers must uphold the packet integrity contract of crate::CuStreamRx.

Auto Trait Implementations§

§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> Freeze for ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>
where Box<Decoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>>: Freeze, Option<SourceObserver<MAX_WINDOW_SYMBOLS>>: Freeze,

§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> RefUnwindSafe for ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>
where Box<Decoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>>: RefUnwindSafe, Option<SourceObserver<MAX_WINDOW_SYMBOLS>>: RefUnwindSafe,

§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> Send for ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>
where Box<Decoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>>: Send, Option<SourceObserver<MAX_WINDOW_SYMBOLS>>: Send,

§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> Sync for ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>
where Box<Decoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>>: Sync, Option<SourceObserver<MAX_WINDOW_SYMBOLS>>: Sync,

§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> Unpin for ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>
where Box<Decoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>>: Unpin, Option<SourceObserver<MAX_WINDOW_SYMBOLS>>: Unpin,

§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> UnsafeUnpin for ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>
where Box<Decoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>>: UnsafeUnpin, Option<SourceObserver<MAX_WINDOW_SYMBOLS>>: UnsafeUnpin,

§

impl<const MAX_SYMBOL_SIZE: usize, const MAX_WINDOW_SYMBOLS: usize, const MAX_EQUATIONS: usize> UnwindSafe for ContinuousDecoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>
where Box<Decoder<MAX_SYMBOL_SIZE, MAX_WINDOW_SYMBOLS, MAX_EQUATIONS>>: UnwindSafe, Option<SourceObserver<MAX_WINDOW_SYMBOLS>>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<A> Is for A
where A: Any,

§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
§

impl<T> PayloadDefaultHandlePolicyApply for T
where T: ?Sized,

§

fn apply_handle_content_policy(&self, _mode: HandleContent)

§

impl<T> PayloadDefaultLoggingPolicy for T
where T: ?Sized,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.