Struct s2n_quic_core::packet::number::map::Map

pub struct Map<V> { /* private fields */ }

A data structure for tracking packets that are pending acknowledgement

The following assumptions are made and exploited

• Packet numbers are monotonically generated and inserted
• Packet numbers will mostly be removed in ranges
• Packet numbers that are deemed lost will also be removed and retransmitted

This is implemented as a buffer ring with a moving range for the lower and upper bound of contained packet numbers. The following example illustrates how each field tracks state:

packets = [ PN(2), None, PN(0), PN(1) ]
                          ^ index = 2
start = PN(0)
end = PN(2)

Upon inserting PN(3) the state is now:

packets = [ PN(2), PN(3), PN(0), PN(1) ]
                          ^ index = 2
start = PN(0)
end = PN(3)

Upon removing PN(0) the state is now:

packets = [ PN(2), PN(3), None, PN(1) ]
                                ^ index = 3
start = PN(1)
end = PN(3)

Implementations

impl<V> Map<V>

pub fn insert(&mut self, packet_number: PacketNumber, value: V)

Inserts the given value

pub fn insert_or_update<F: FnOnce(&mut V)>( &mut self, packet_number: PacketNumber, value: V, update: F )

Inserts the given value into the map or updates the existing entry

pub fn get(&self, packet_number: PacketNumber) -> Option<&V>

Returns a reference to the V associated with the given packet_number

pub fn remove(&mut self, packet_number: PacketNumber) -> Option<V>

Removes the value associated with the given packet_number and returns the value if it was present

pub fn remove_range(&mut self, range: PacketNumberRange) -> RemoveIter<'_, V>

Removes a range of packets from the map and returns their value

pub fn get_range(&self) -> PacketNumberRange

Get the inclusive PacketNumberRange

pub fn iter(&self) -> Iter<'_, V>

Gets an iterator over the sent packet entries, sorted by PacketNumber

pub fn is_empty(&self) -> bool

Returns true if there are no entries

pub fn clear(&mut self)

Clears all of the packet information in the sent

Trait Implementations

impl<V: Clone> Clone for Map<V>

fn clone(&self) -> Map<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for Map<V>

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

Formats the value using the given formatter.

impl<V> Default for Map<V>

fn default() -> Self

Returns the “default value” for a type.