Struct cap_std::net::UdpSocket

pub struct UdpSocket { /* private fields */ }

Available on non-WASI only.

A UDP socket.

This corresponds to std::net::UdpSocket.

This UdpSocket has no bind, connect, or send_to methods. To create a UdpSocket bound to an address or to send a message to an address, first obtain a Pool permitting the address, and then call Pool::bind_udp_socket, or Pool::connect_udp_socket, or Pool::send_to_udp_socket_addr.

Implementations

impl UdpSocket

pub fn from_std(std: UdpSocket) -> Self

Constructs a new instance of Self from the given std::net::UdpSocket.

This grants access the resources the std::net::UdpSocket instance already has access to.

pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>

Receives a single datagram message on the socket.

This corresponds to std::net::UdpSocket::recv_from.

pub fn peek_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>

Receives a single datagram message on the socket, without removing it from the queue.

This corresponds to std::net::UdpSocket::peek_from.

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the socket address of the remote peer this socket was connected to.

This corresponds to std::net::UdpSocket::peer_addr.

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the socket address that this socket was created from.

This corresponds to std::net::UdpSocket::local_addr.

pub fn try_clone(&self) -> Result<Self>

Creates a new independently owned handle to the underlying socket.

This corresponds to std::net::UdpSocket::try_clone.

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>

Sets the read timeout to the timeout specified.

This corresponds to std::net::UdpSocket::set_read_timeout.

pub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<()>

Sets the write timeout to the timeout specified.

This corresponds to std::net::UdpSocket::set_write_timeout.

pub fn read_timeout(&self) -> Result<Option<Duration>>

Returns the read timeout of this socket.

This corresponds to std::net::UdpSocket::read_timeout.

pub fn write_timeout(&self) -> Result<Option<Duration>>

Returns the write timeout of this socket.

This corresponds to std::net::UdpSocket::write_timeout.

pub fn set_broadcast(&self, broadcast: bool) -> Result<()>

Sets the value of the SO_BROADCAST option for this socket.

This corresponds to std::net::UdpSocket::set_broadcast.

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

Gets the value of the SO_BROADCAST option for this socket.

This corresponds to std::net::UdpSocket::broadcast.

pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> Result<()>

Sets the value of the IP_MULTICAST_LOOP option for this socket.

This corresponds to std::net::UdpSocket::set_multicast_loop_v4.

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

Gets the value of the IP_MULTICAST_LOOP option for this socket.

This corresponds to std::net::UdpSocket::multicast_loop_v4.

pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> Result<()>

Sets the value of the IP_MULTICAST_TTL option for this socket.

This corresponds to std::net::UdpSocket::set_multicast_ttl_v4.

pub fn multicast_ttl_v4(&self) -> Result<u32>

Gets the value of the IP_MULTICAST_TTL option for this socket.

This corresponds to std::net::UdpSocket::multicast_ttl_v4.

pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> Result<()>

Sets the value of the IPV6_MULTICAST_LOOP option for this socket.

This corresponds to std::net::UdpSocket::set_multicast_loop_v6.

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

Gets the value of the IPV6_MULTICAST_LOOP option for this socket.

This corresponds to std::net::UdpSocket::multicast_loop_v6.

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

Sets the value for the IP_TTL option on this socket.

This corresponds to std::net::UdpSocket::set_ttl.

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

Gets the value of the IP_TTL option for this socket.

This corresponds to std::net::UdpSocket::ttl.

pub fn join_multicast_v4(
    &self,
    multiaddr: &Ipv4Addr,
    interface: &Ipv4Addr
) -> Result<()>

Executes an operation of the IP_ADD_MEMBERSHIP type.

This corresponds to std::net::UdpSocket::join_multicast_v4.

pub fn join_multicast_v6(
    &self,
    multiaddr: &Ipv6Addr,
    interface: u32
) -> Result<()>

Executes an operation of the IPV6_ADD_MEMBERSHIP type.

This corresponds to std::net::UdpSocket::join_multicast_v6.

pub fn leave_multicast_v4(
    &self,
    multiaddr: &Ipv4Addr,
    interface: &Ipv4Addr
) -> Result<()>

Executes an operation of the IP_DROP_MEMBERSHIP type.

This corresponds to std::net::UdpSocket::leave_multicast_v4.

pub fn leave_multicast_v6(
    &self,
    multiaddr: &Ipv6Addr,
    interface: u32
) -> Result<()>

Executes an operation of the IPV6_DROP_MEMBERSHIP type.

This corresponds to std::net::UdpSocket::leave_multicast_v6.

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

Gets the value of the SO_ERROR option on this socket.

This corresponds to std::net::UdpSocket::take_error.

pub fn send(&self, buf: &[u8]) -> Result<usize>

Sends data on the socket to the remote address to which it is connected.

This corresponds to std::net::UdpSocket::send.

pub fn recv(&self, buf: &mut [u8]) -> Result<usize>

Receives a single datagram message on the socket from the remote address to which it is connected.

This corresponds to std::net::UdpSocket::recv.

pub fn peek(&self, buf: &mut [u8]) -> Result<usize>

Receives single datagram on the socket from the remote address to which it is connected, without removing the message from input queue.

This corresponds to std::net::UdpSocket::peek.

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Moves this UDP socket into or out of nonblocking mode.

This corresponds to std::net::UdpSocket::set_nonblocking.

Trait Implementations

impl AsFd for UdpSocket

Available on non-Windows only.

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for UdpSocket

Available on non-Windows only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UdpSocket

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

Formats the value using the given formatter.

impl FromFd for UdpSocket

Available on non-Windows only.

fn from_fd(fd: OwnedFd) -> Self

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

fn from_into_fd<Owned>(into_owned: Owned) -> Selfwhere
    Owned: IntoFd,

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

impl FromRawFd for UdpSocket

Available on non-Windows only.

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoFd for UdpSocket

Available on non-Windows only.

fn into_fd(self) -> OwnedFd

Consumes this object, returning the underlying file descriptor.

impl IntoRawFd for UdpSocket

Available on non-Windows only.

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.