Struct UdpConfig 

pub struct UdpConfig {

    pub socket_family: SocketFamily,
    pub socket_type: UdpSocketType,
    pub bind_addr: Option<SocketAddr>,
    pub reuseaddr: Option<bool>,
    pub reuseport: Option<bool>,
    pub broadcast: Option<bool>,
    pub ttl: Option<u32>,
    pub hoplimit: Option<u32>,
    pub read_timeout: Option<Duration>,
    pub write_timeout: Option<Duration>,
    pub recv_buffer_size: Option<usize>,
    pub send_buffer_size: Option<usize>,
    pub tos: Option<u32>,
    pub tclass_v6: Option<u32>,
    pub recv_pktinfo: Option<bool>,
    pub only_v6: Option<bool>,
    pub bind_device: Option<String>,
}

Configuration options for a UDP socket.

Fields

socket_family: SocketFamily

The socket family.

socket_type: UdpSocketType

The socket type (DGRAM or RAW).

bind_addr: Option<SocketAddr>

Address to bind. If None, the operating system chooses the address.

reuseaddr: Option<bool>

Enable address reuse (SO_REUSEADDR).

reuseport: Option<bool>

Whether to allow port reuse (SO_REUSEPORT) where supported.

broadcast: Option<bool>

Allow broadcast (SO_BROADCAST).

ttl: Option<u32>

Time to live value.

hoplimit: Option<u32>

Hop limit value.

read_timeout: Option<Duration>

Read timeout for the socket.

write_timeout: Option<Duration>

Write timeout for the socket.

recv_buffer_size: Option<usize>

Optional receive buffer size in bytes.

send_buffer_size: Option<usize>

Optional send buffer size in bytes.

tos: Option<u32>

Optional IPv4 TOS / DSCP field value.

tclass_v6: Option<u32>

Optional IPv6 traffic class value (IPV6_TCLASS) where supported.

recv_pktinfo: Option<bool>

Enable receiving packet info ancillary data (IP_PKTINFO / IPV6_RECVPKTINFO) where supported.

only_v6: Option<bool>

Whether to force IPv6-only behavior on dual-stack sockets.

bind_device: Option<String>

Bind to a specific interface (Linux only).

Implementations

impl UdpConfig

pub fn new() -> Self

Create a new UDP configuration with default values.

pub fn new_with_family(socket_family: SocketFamily) -> Self

Create a new UDP configuration for a specific socket family.

pub fn with_socket_family(self, socket_family: SocketFamily) -> Self

Set the socket family.

pub fn with_bind_addr(self, addr: SocketAddr) -> Self

Set the bind address.

pub fn with_bind(self, addr: SocketAddr) -> Self

Set the bind address.

pub fn with_reuseaddr(self, on: bool) -> Self

Enable address reuse.

pub fn with_reuseport(self, on: bool) -> Self

Enable port reuse.

pub fn with_broadcast(self, on: bool) -> Self

Allow broadcast.

pub fn with_ttl(self, ttl: u32) -> Self

Set the time to live value.

pub fn with_hoplimit(self, hops: u32) -> Self

Set the hop limit value.

pub fn with_hop_limit(self, hops: u32) -> Self

Set the hop limit value.

pub fn with_read_timeout(self, timeout: Duration) -> Self

Set the read timeout.

pub fn with_write_timeout(self, timeout: Duration) -> Self

Set the write timeout.

pub fn with_recv_buffer_size(self, size: usize) -> Self

Set the receive buffer size.

pub fn with_send_buffer_size(self, size: usize) -> Self

Set the send buffer size.

pub fn with_tos(self, tos: u32) -> Self

Set the IPv4 TOS / DSCP field value.

pub fn with_tclass_v6(self, tclass: u32) -> Self

Set the IPv6 traffic class value.

pub fn with_recv_pktinfo(self, on: bool) -> Self

Enable packet-info ancillary data receiving.

pub fn with_only_v6(self, only_v6: bool) -> Self

Set whether the socket is IPv6 only.

pub fn with_bind_device(self, iface: impl Into<String>) -> Self

Bind to a specific interface (Linux only).

pub fn validate(&self) -> Result<()>

Validate the configuration before socket creation.

Trait Implementations

impl Clone for UdpConfig

fn clone(&self) -> UdpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UdpConfig

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

Formats the value using the given formatter.

impl Default for UdpConfig

fn default() -> Self

Returns the “default value” for a type.