Struct PartialDecode 

pub struct PartialDecode { /* private fields */ }

Available on crate feature quic only.

Decodes a QUIC packet’s invariant header

Due to packet number encryption, it is impossible to fully decode a header (which includes a variable-length packet number) without crypto context. The crypto context (the packet protection keys) is usually part of the Connection, or can be derived from the destination CID for Initial packets.

To cope with this, we decode the invariant header (which should be stable across QUIC versions), which gives us the destination CID and allows us to inspect the version and packet type (which depends on the version). This information allows us to fully decode and decrypt the packet.

Implementations

impl PartialDecode

pub fn new( bytes: BytesMut, cid_parser: &(impl ConnectionIdParser + ?Sized), supported_versions: &[Version], grease_quic_bit: bool, ) -> Result<(PartialDecode, Option<BytesMut>), PacketDecodeError>

Begin decoding a QUIC packet from bytes, returning any trailing data not part of that packet

pub fn data(&self) -> &[u8]

The underlying partially-decoded packet data

pub fn initial_header(&self) -> Option<&ProtectedInitialHeader>

pub fn has_long_header(&self) -> bool

pub fn is_initial(&self) -> bool

pub fn space(&self) -> Option<SpaceId>

pub fn is_0rtt(&self) -> bool

pub fn version(&self) -> Option<Version>

The version a long header carries; short headers have none.

pub fn wire_version(&self) -> Option<WireVersion>

The wire-bearing version a long header carries; short headers have none.

pub fn dst_cid(&self) -> &ConnectionId

The destination connection ID of the packet

pub fn len(&self) -> usize

Length of QUIC packet being decoded

pub fn finish_protected( self, header_crypto: &dyn HeaderKey, ) -> Result<Packet, PacketDecodeError>

Finish decoding a header that carries a protected packet number (Initial, Handshake, 0-RTT, 1-RTT), removing header protection with header_crypto. The key is mandatory, so a caller cannot reach a number-bearing header without one.

pub fn finish_unprotected(self) -> Result<Packet, PacketDecodeError>

Finish decoding a header that carries no packet number (Retry, Version Negotiation), which needs no key. A number-bearing header handed here is reported as an invalid header rather than decoded without protection.

Trait Implementations

impl Clone for PartialDecode

fn clone(&self) -> PartialDecode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialDecode

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

Formats the value using the given formatter.