Struct Datagrams 

pub struct Datagrams {
    pub ecn: Option<EcnCodepoint>,
    pub segment_size: Option<NonZeroU16>,
    pub contents: Bytes,
}

One or multiple datagrams being transferred via the relay.

This type is modeled after quinn_proto::Transmit (or even more similarly quinn_udp::Transmit, but we don’t depend on that library here).

Fields

ecn: Option<EcnCodepoint>

Explicit congestion notification bits

segment_size: Option<NonZeroU16>

The segment size if this transmission contains multiple datagrams. This is None if the transmit only contains a single datagram

contents: Bytes

The contents of the datagram(s)

Implementations

impl Datagrams

pub fn take_segments(&mut self, num_segments: usize) -> Datagrams

Splits the current datagram into at maximum num_segments segments, returning the batch with at most num_segments and leaving only the rest in self.

Calling this on a datagram batch that only contains a single datagram (segment_size == None) will result in returning essentially a clone of self, while making self empty afterwards.

Calling this on a datagram batch with e.g. 15 datagrams with num_segments == 10 will result in returning a datagram batch that contains the first 10 datagrams and leave self containing the remaining 5 datagrams.

Calling this on a datagram batch with less than num_segments datagrams will result in making self empty and returning essentially a clone of self.

Trait Implementations

impl Clone for Datagrams

fn clone(&self) -> Datagrams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Datagrams

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

Formats the value using the given formatter.

impl<T: AsRef<[u8]>> From<T> for Datagrams

fn from(bytes: T) -> Self

Converts to this type from the input type.

impl PartialEq for Datagrams

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Datagrams

impl StructuralPartialEq for Datagrams