Struct CapsuleDecoder 

pub struct CapsuleDecoder { /* private fields */ }

Available on crate features http and std only.

An incremental Capsule Protocol decoder.

Implementations

impl CapsuleDecoder

pub fn new(config: CapsuleConfig) -> CapsuleDecoder

Create a decoder with the given limits and policy.

pub fn maybe_with_observation( self, observation: Option<CapsuleObservation>, ) -> CapsuleDecoder

Observe completed metadata from subsequent capsule headers, without retaining value bytes. Incomplete capsules never report parsed, including skipped/forwarded values.

pub fn maybe_set_observation( &mut self, observation: Option<CapsuleObservation>, ) -> &mut CapsuleDecoder

Observe completed metadata from subsequent capsule headers, without retaining value bytes. Incomplete capsules never report parsed, including skipped/forwarded values.

pub fn with_observation(self, observation: CapsuleObservation) -> CapsuleDecoder

Observe completed metadata from subsequent capsule headers, without retaining value bytes. Incomplete capsules never report parsed, including skipped/forwarded values.

pub fn set_observation( &mut self, observation: CapsuleObservation, ) -> &mut CapsuleDecoder

Observe completed metadata from subsequent capsule headers, without retaining value bytes. Incomplete capsules never report parsed, including skipped/forwarded values.

pub fn without_observation(self) -> CapsuleDecoder

Observe completed metadata from subsequent capsule headers, without retaining value bytes. Incomplete capsules never report parsed, including skipped/forwarded values.

pub fn unset_observation(&mut self) -> &mut CapsuleDecoder

Observe completed metadata from subsequent capsule headers, without retaining value bytes. Incomplete capsules never report parsed, including skipped/forwarded values.

pub fn feed(&mut self, input: Bytes) -> Result<(), CapsuleError>

Supply the next chunk of the data stream. Drain Self::poll first.

pub fn is_drained(&self) -> bool

Whether all fed input has been consumed.

pub fn dropped_datagrams(&self) -> u64

Oversized DATAGRAM capsules discarded so far.

pub fn finish(&self) -> Result<(), CapsuleError>

Check that a cleanly ended data stream did not end inside a capsule (RFC 9297 §3.3).

pub fn poll(&mut self) -> Result<Option<CapsuleEvent>, CapsuleError>

Decode the next event, or None once more input is needed.

Trait Implementations

impl Debug for CapsuleDecoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.