Struct CapsuleDecoder 

pub struct CapsuleDecoder { /* private fields */ }

An incremental capsule decoder.

Feed it bytes with CapsuleDecoder::push, then drain with CapsuleDecoder::next_capsule until it yields None.

Implementations

impl CapsuleDecoder

pub fn new() -> Self

A decoder positioned at the start of a capsule sequence.

pub fn push(&mut self, chunk: &[u8])

Adds received bytes. Any number, split anywhere.

Taken by slice because that is all this does with them: the bytes are copied into the decoder’s own buffer, where the next capsule is cut out of them, so nothing is gained by owning the chunk they arrived in.

pub fn at_capsule_boundary(&self) -> bool

Whether the sequence is currently between capsules.

False at end of stream means the peer stopped mid-capsule, which RFC 9297 §3.3 makes a malformed message.

pub fn next_capsule(&mut self) -> Result<Option<Capsule>, Error>

Decodes the next capsule of interest.

Ok(None) means more bytes are needed — not an error. Unknown capsule types are consumed internally and never returned.

Trait Implementations

impl Debug for CapsuleDecoder

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

Formats the value using the given formatter.

impl Default for CapsuleDecoder

fn default() -> Self

Returns the “default value” for a type.