Struct cap_std::os::unix::net::UnixDatagram

pub struct UnixDatagram { /* private fields */ }

Available on Unix only.

A Unix datagram socket.

This corresponds to std::os::unix::net::UnixDatagram.

This UnixDatagram has no bind, connect, or send_to methods. To create a UnixDatagram, first obtain a Dir containing the path, and then call Dir::bind_unix_datagram, Dir::connect_unix_datagram, or Dir::send_to_unix_datagram_addr.

Implementations

impl UnixDatagram

pub fn from_std(std: UnixDatagram) -> Self

Constructs a new instance of Self from the given std::os::unix::net::UnixDatagram.

This grants access the resources the std::os::unix::net::UnixDatagram instance already has access to.

pub fn unbound() -> Result<Self>

Creates a Unix Datagram socket which is not bound to any address.

This corresponds to std::os::unix::net::UnixDatagram::unbound.

TODO: should this require a capability?

pub fn pair() -> Result<(Self, Self)>

Creates an unnamed pair of connected sockets.

This corresponds to std::os::unix::net::UnixDatagram::pair.

TODO: should this require a capability?

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

Creates a new independently owned handle to the underlying socket.

This corresponds to std::os::unix::net::UnixDatagram::try_clone.

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

Returns the address of this socket.

This corresponds to std::os::unix::net::UnixDatagram::local_addr.

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

Returns the address of this socket’s peer.

This corresponds to std::os::unix::net::UnixDatagram::peer_addr.

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

Receives data from the socket.

This corresponds to std::os::unix::net::UnixDatagram::recv_from.

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

Receives data from the socket.

This corresponds to std::os::unix::net::UnixDatagram::recv.

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

Sends data on the socket to the socket’s peer.

This corresponds to std::os::unix::net::UnixDatagram::send.

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

Sets the read timeout for the socket.

This corresponds to std::os::unix::net::UnixDatagram::set_read_timeout.

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

Sets the write timeout for the socket.

This corresponds to std::os::unix::net::UnixDatagram::set_write_timeout.

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

Returns the read timeout of this socket.

This corresponds to std::os::unix::net::UnixDatagram::read_timeout.

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

Returns the write timeout of this socket.

This corresponds to std::os::unix::net::UnixDatagram::write_timeout.

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

Moves the socket into or out of nonblocking mode.

This corresponds to std::os::unix::net::UnixDatagram::set_nonblocking.

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

Returns the value of the SO_ERROR option.

This corresponds to std::os::unix::net::UnixDatagram::take_error.

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shut down the read, write, or both halves of this connection.

This corresponds to std::os::unix::net::UnixDatagram::shutdown.

Trait Implementations

impl AsFd for UnixDatagram

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

Borrows the file descriptor.

impl AsRawFd for UnixDatagram

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UnixDatagram

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

Formats the value using the given formatter.

impl From<OwnedFd> for UnixDatagram

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<UnixDatagram> for OwnedFd

fn from(datagram: UnixDatagram) -> OwnedFd

Converts to this type from the input type.

impl FromRawFd for UnixDatagram

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for UnixDatagram

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.