Struct s2n_quic_core::packet::number::PacketNumber

pub struct PacketNumber(_);

Contains a fully-decoded packet number in a given space

Internally the packet number is represented as a NonZeroU64 to ensure optimal memory layout.

The lower 62 bits are used to store the actual packet number value. The upper 2 bits are used to store the packet number space. Because there are only 3 spaces, the zero state is never used, which is why NonZeroU64 can be used instead of u64.

Implementations

impl PacketNumber

pub fn space(self) -> PacketNumberSpace

Returns the PacketNumberSpace for the given PacketNumber

pub const fn as_varint(packet_number: Self) -> VarInt

Converts the PacketNumber into a VarInt value.

Note: Even though some scenarios require this function, it should be avoided in most cases, as it removes the corresponding PacketNumberSpace and allows math operations to be performed, which can easily result in protocol errors.

pub fn truncate(
    self,
    largest_acknowledged_packet_number: Self
) -> Option<TruncatedPacketNumber>

Truncates the PacketNumber into a TruncatedPacketNumber based on the largest acknowledged packet number

pub fn next(self) -> Option<Self>

Compute the next packet number in the space. If the packet number has exceeded the maximum value allowed None will be returned.

pub fn prev(self) -> Option<Self>

Compute the prev packet number in the space. If the packet number has underflowed None will be returned.

pub const fn as_crypto_nonce(self) -> u64

Create a nonce for crypto from the packet number value

Note: This should not be used by anything other than crypto-related functionality.

pub const fn as_u64(self) -> u64

Returns the value with the top 2 bits removed

pub fn checked_distance(self, rhs: PacketNumber) -> Option<u64>

Computes the distance between this packet number and the given packet number, returning None if overflow occurred.

Trait Implementations

impl Clone for PacketNumber

fn clone(&self) -> PacketNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PacketNumber

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

Formats the value using the given formatter.

impl Default for PacketNumber

fn default() -> Self

Returns the “default value” for a type.

impl Display for PacketNumber

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

Formats the value using the given formatter.

impl Hash for PacketNumber

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, 

Feeds a slice of this type into the given Hasher.

impl IntoEvent<u64> for PacketNumber

fn into_event(self) -> u64

impl Ord for PacketNumber

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PacketNumber> for PacketNumber

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<PacketNumber> for PacketNumber

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Set for PacketNumber

fn contains(&self, packet_number: PacketNumber) -> bool

Returns whether the Set contains a given packet number

fn smallest(&self) -> PacketNumber

Smallest packet number in the set

fn largest(&self) -> PacketNumber

Largest packet number in the set

fn as_range(&self) -> PacketNumberRange

Returns the range of packet numbers contained in the set

impl Copy for PacketNumber

impl Eq for PacketNumber

impl StructuralEq for PacketNumber