Struct mio::net::UnixDatagram

pub struct UnixDatagram { /* fields omitted */ }

This is supported on crate features tcp or udp or uds only.

A Unix datagram socket.

Implementations

impl UnixDatagram

pub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixDatagram>

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Creates a Unix datagram socket bound to the given path.

pub fn from_std(socket: UnixDatagram) -> UnixDatagram

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Creates a new UnixDatagram from a standard net::UnixDatagram.

This function is intended to be used to wrap a Unix datagram from the standard library in the Mio equivalent. The conversion assumes nothing about the underlying datagram; ; it is left up to the user to set it in non-blocking mode.

pub fn connect<P: AsRef<Path>>(&self, path: P) -> Result<()>

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Connects the socket to the specified address.

pub fn unbound() -> Result<UnixDatagram>

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

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

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Create an unnamed pair of connected sockets.

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Returns the address of this socket.

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Returns the address of this socket's peer.

The connect method will connect the socket to a peer.

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Receives data from the socket.

On success, returns the number of bytes read and the address from whence the data came.

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Receives data from the socket.

On success, returns the number of bytes read.

pub fn send_to<P: AsRef<Path>>(&self, buf: &[u8], path: P) -> Result<usize>

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Sends data on the socket to the specified address.

On success, returns the number of bytes written.

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

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

The peer address may be set by the connect method, and this method will return an error if the socket has not already been connected.

On success, returns the number of bytes written.

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

Returns the value of the SO_ERROR option.

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

This is supported on (crate features tcp or udp or uds) and crate feature uds only.

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

This function will cause all pending and future I/O calls on the specified portions to immediately return with an appropriate value (see the documentation of Shutdown).

Trait Implementations

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 FromRawFd for UnixDatagram

unsafe fn from_raw_fd(fd: RawFd) -> UnixDatagram

Converts a RawFd to a UnixDatagram.

Notes

The caller is responsible for ensuring that the socket is in non-blocking mode.

impl IntoRawFd for UnixDatagram

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Source for UnixDatagram

fn register(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Register self with the given Registry instance.

fn reregister(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Re-register self with the given Registry instance.

fn deregister(&mut self, registry: &Registry) -> Result<()>

Deregister self from the given Registry instance.