Struct DatagramCapabilities 

#[non_exhaustive]
pub struct DatagramCapabilities {

    pub max_payload_ipv4: usize,
    pub max_payload_ipv6: usize,
    pub max_receive_batch: usize,
    pub max_send_batch: usize,
    pub max_send_segments: usize,
    pub max_receive_segments: usize,
    pub may_fragment: bool,
    pub send_ecn: bool,
    pub receive_ecn: bool,
    pub send_source_ip: bool,
    pub receive_local_ip: bool,
    pub receive_interface: bool,
    pub receive_original_destination: bool,
    pub receive_timestamp: bool,
    pub receive_truncation: bool,
}

Available on crate features std and udp only.

UDP implementation and ancillary-I/O capabilities of a socket.

This is a snapshot. A backend can lower an offload limit after the kernel or driver rejects an attempted operation, so callers should query capabilities again after an offload error. A segmented send is atomic from this API’s perspective: implementations never hide such a rejection by splitting it into several ordinary sends.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_payload_ipv4: usize

Maximum unsegmented IPv4 UDP payload accepted by this implementation.

max_payload_ipv6: usize

Maximum unsegmented IPv6 UDP payload accepted by this implementation.

max_receive_batch: usize

Maximum receive entries that can be filled by one optimized operation.

max_send_batch: usize

Maximum send entries that can be attempted by one optimized operation.

max_send_segments: usize

Maximum datagrams represented by one segmented send descriptor.

This is the authoritative validation limit. It can be backed by native offload or by an implementation such as the deterministic test socket.

max_receive_segments: usize

Maximum datagrams represented by one receive buffer.

This is the authoritative coalesced-entry limit, regardless of how the implementation produces such entries.

may_fragment: bool

Whether outgoing IP packets might be fragmented by the network stack.

This says only whether the socket backend successfully enabled a don’t-fragment policy. It is not a path MTU estimate.

send_ecn: bool

Whether outgoing ECN selection is supported.

receive_ecn: bool

Whether received ECN codepoints are reported.

send_source_ip: bool

Whether an outgoing source IP can be selected per datagram.

receive_local_ip: bool

Whether the effective local destination IP is reported per datagram.

receive_interface: bool

Whether the incoming interface index is reported.

receive_original_destination: bool

Whether transparent-proxy original destinations are reported.

receive_timestamp: bool

Whether receive timestamps are reported.

receive_truncation: bool

Whether receive truncation is detected instead of silently discarded.

Implementations

impl DatagramCapabilities

pub const fn max_payload_for(self, address: SocketAddress) -> usize

Return the implementation payload ceiling for address’s IP family.

pub const fn supports(self, feature: DatagramFeature) -> bool

Whether this snapshot provides feature.

pub const fn portable() -> DatagramCapabilities

Conservative capabilities for a portable one-packet fallback.

Trait Implementations

impl Clone for DatagramCapabilities

fn clone(&self) -> DatagramCapabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DatagramCapabilities

impl Debug for DatagramCapabilities

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

Formats the value using the given formatter.

impl Default for DatagramCapabilities

fn default() -> DatagramCapabilities

Returns the “default value” for a type.

impl Eq for DatagramCapabilities

impl PartialEq for DatagramCapabilities

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DatagramCapabilities