Struct VarIntDecoder 

pub struct VarIntDecoder { /* private fields */ }

Available on crate feature quic only.

Incremental, fragmentation-safe decoder for a single QUIC variable-length integer.

VarInt’s Codec::decode consumes the leading byte before it can report that a multi-byte integer was truncated, so retrying it on input delivered in arbitrary chunks — an HTTP/3 stream, for instance — silently loses framing. This decoder retains partial state across calls instead: feed it whatever bytes are currently available and it consumes only the bytes belonging to the integer, returning None when it needs more. It never consumes a byte it cannot account for, so the same decoder can be driven from non-contiguous buffers. After it returns Some, it resets and is ready for the next integer.

Implementations

impl VarIntDecoder

pub const fn new() -> VarIntDecoder

Create a decoder with no buffered state.

pub const fn in_progress(&self) -> bool

Whether bytes of an in-progress integer are buffered.

A caller that reaches end of input while this is true holds a truncated integer and should treat it as a framing error rather than a clean end.

pub fn decode<B>(&mut self, r: &mut B) -> Option<VarInt>

where B: Buf,

Feed the currently available bytes.

Consumes only the bytes belonging to the integer being decoded. Returns Some(value) once a complete integer has been read (resetting for reuse), or None if more input is required, in which case the buffered progress is retained for the next call.

Trait Implementations

impl Clone for VarIntDecoder

fn clone(&self) -> VarIntDecoder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VarIntDecoder

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

Formats the value using the given formatter.

impl Default for VarIntDecoder

fn default() -> VarIntDecoder

Returns the “default value” for a type.