Struct UnixDatagram

Source

pub struct UnixDatagram { /* private fields */ }

Available on crate feature uds only.

Expand description

An I/O object representing a Unix datagram socket.

Implementations§

Source §

impl UnixDatagram

Source

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

Creates a new UnixDatagram bound to the specified path.

Source

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

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.

Source

pub fn from_std(datagram: UnixDatagram) -> Result<UnixDatagram>

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.

§Panics

This function panics if thread-local runtime is not set.

The runtime is usually set implicitly when this function is called from a future driven by a tokio runtime, otherwise runtime can be set explicitly with Handle::enter function.

Source

pub fn unbound() -> Result<UnixDatagram>

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

Source

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

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.

Source

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

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

Source

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

Receives data from the socket.

Source

pub async fn send_to(&mut self, buf: &[u8], target: P) -> Result<usize>
where P: AsRef<Path> + Unpin,

Sends data on the socket to the specified address.

Source

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

Receives data from the socket.

Source

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

Returns the local address that this socket is bound to.

Source

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

Returns the address of this socket’s peer.

The connect method will connect the socket to a peer.

Source

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

Returns the value of the SO_ERROR option.

Source

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

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