Struct net2::UdpBuilder

pub struct UdpBuilder { /* fields omitted */ }

An "in progress" UDP socket which has not yet been connected.

Allows configuration of a socket before the socket is connected.

Methods

impl UdpBuilder

pub fn new_v4() -> Result<UdpBuilder>

Constructs a new UdpBuilder with the AF_INET domain, the SOCK_DGRAM type, and with a protocol argument of 0.

Note that passing other kinds of flags or arguments can be done through the FromRaw{Fd,Socket} implementation.

pub fn new_v6() -> Result<UdpBuilder>

Constructs a new UdpBuilder with the AF_INET6 domain, the SOCK_DGRAM type, and with a protocol argument of 0.

Note that passing other kinds of flags or arguments can be done through the FromRaw{Fd,Socket} implementation.

pub fn bind<T>(&self, addr: T) -> Result<UdpSocket> where
    T: ToSocketAddrs, 

Binds this socket to the specified address.

This function directly corresponds to the bind(2) function on Windows and Unix.

impl UdpBuilder

pub fn ttl(&self, ttl: u32) -> Result<&Self>

Sets the value for the IP_TTL option on this socket.

This is the same as TcpStreamExt::set_ttl.

pub fn only_v6(&self, only_v6: bool) -> Result<&Self>

Sets the value for the IPV6_V6ONLY option on this socket.

This is the same as TcpStream::only_v6.

pub fn reuse_address(&self, reuse: bool) -> Result<&Self>

Set value for the SO_REUSEADDR option on this socket.

This is the same as TcpBuilder::reuse_address.

pub fn get_reuse_address(&self) -> Result<bool>

Check the SO_REUSEADDR option on this socket.

pub fn take_error(&self) -> Result<Option<Error>>

Get the value of the SO_ERROR option on this socket.

This will retrieve the stored error in the underlying socket, clearing the field in the process. This can be useful for checking errors between calls.

Trait Implementations

impl AsRawFd for UdpBuilder

fn as_raw_fd(&self) -> c_int

Extracts the raw file descriptor.

impl Debug for UdpBuilder

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

Formats the value using the given formatter.

impl FromRawFd for UdpBuilder

unsafe fn from_raw_fd(fd: c_int) -> UdpBuilder

Constructs a new instance of Self from the given raw file descriptor.

impl UnixUdpBuilderExt for UdpBuilder

fn reuse_port(&self, reuse: bool) -> Result<&Self>

Set value for the SO_REUSEPORT option on this socket.

fn get_reuse_port(&self) -> Result<bool>

Check the value of the SO_REUSEPORT option on this socket.