Enum LengthWidth 

#[non_exhaustive]
pub enum LengthWidth {
    U8,
    U16,
    U32,
    U24,
    U64,
}

Width of the length prefix, in bytes.

Marked #[non_exhaustive] so wider prefix widths can be added in future minor releases without a major version bump.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

U8

One-byte length prefix; payload up to 255 bytes.

U16

Two-byte length prefix; payload up to 65 535 bytes.

U32

Four-byte length prefix; payload up to 4 294 967 295 bytes.

U24

Three-byte length prefix; payload up to 16 777 215 bytes.

Used by HTTP/2 frame headers, TLS handshake messages, and MySQL packets.

U64

Eight-byte length prefix; payload up to u64::MAX bytes.

On targets where usize is narrower than 64 bits, a length that does not fit in usize is reported as Error::FrameTooLarge.

Implementations

impl LengthWidth

pub const fn header_size(self) -> usize

Width of the prefix in bytes.

Example

use wire_codec::framing::LengthWidth;
assert_eq!(LengthWidth::U24.header_size(), 3);

pub const fn max_payload(self) -> u64

Largest value the prefix can encode.

Example

use wire_codec::framing::LengthWidth;
assert_eq!(LengthWidth::U16.max_payload(), 65_535);

Trait Implementations

impl Clone for LengthWidth

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LengthWidth

impl Debug for LengthWidth

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

Formats the value using the given formatter.

impl Eq for LengthWidth

impl Hash for LengthWidth

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LengthWidth

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LengthWidth