Struct tokio::net::unix::UnixDatagram

pub struct UnixDatagram { /* fields omitted */ }

An I/O object representing a Unix datagram socket.

Methods

impl UnixDatagram

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

Creates a new UnixDatagram bound to the specified path.

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

Creates an unnamed pair of connected sockets.

This function will create a pair of interconnected Unix sockets for communicating back and forth between one another. Each socket will be associated with the default event loop's handle.

pub fn from_std(
    datagram: UnixDatagram,
    handle: &Handle
) -> Result<UnixDatagram, Error>

Consumes a UnixDatagram in the standard library and returns a nonblocking UnixDatagram from this crate.

The returned datagram will be associated with the given event loop specified by handle and is ready to perform I/O.

pub fn unbound() -> Result<UnixDatagram, Error>

Creates a new UnixDatagram which is not bound to any address.

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

Connects the socket to the specified address.

The send method may be used to send data to the specified address. recv and recv_from will only receive data from that address.

pub fn send(
    &'_ mut self,
    buf: &'_ [u8]
) -> impl Future<Output = Result<usize, Error>>

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

pub fn recv(
    &'_ mut self,
    buf: &'_ mut [u8]
) -> impl Future<Output = Result<usize, Error>>

Receives data from the socket.

pub fn send_to<P>(
    &'_ mut self,
    buf: &'_ [u8],
    target: P
) -> impl Future<Output = Result<usize, Error>> where
    P: AsRef<Path> + Unpin, 

Sends data on the socket to the specified address.

pub fn recv_from(
    &'_ mut self,
    buf: &'_ mut [u8]
) -> impl Future<Output = Result<(usize, SocketAddr), Error>>

Receives data from the socket.

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

Returns the local address that this socket is bound to.

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

Returns the address of this socket's peer.

The connect method will connect the socket to a peer.

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

Returns the value of the SO_ERROR option.

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

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) -> i32

Extracts the raw file descriptor.

impl TryFrom<UnixDatagram> for UnixDatagram

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    stream: UnixDatagram
) -> Result<UnixDatagram, <UnixDatagram as TryFrom<UnixDatagram>>::Error>

Consumes stream, returning the tokio I/O object.

This is equivalent to UnixDatagram::from_std(stream, &Handle::default()).

impl Debug for UnixDatagram

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

Formats the value using the given formatter.