Struct mio_uds::UnixDatagram

pub struct UnixDatagram { /* fields omitted */ }

A Unix datagram socket.

Methods

impl UnixDatagram

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

Creates a Unix datagram socket bound to the given path.

pub fn from_datagram(stream: UnixDatagram) -> Result<UnixDatagram>

Consumes a standard library UnixDatagram and returns a wrapped UnixDatagram compatible with mio.

The returned stream is moved into nonblocking mode and is otherwise ready to get associated with an event loop.

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

Create an unnamed pair of connected sockets.

Returns two UnixDatagramss which are connected to each other.

pub fn unbound() -> Result<UnixDatagram>

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

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.

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

Creates a new independently owned handle to the underlying socket.

The returned UnixListener is a reference to the same socket that this object references. Both handles can be used to accept incoming connections and options set on one listener will affect the other.

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

Returns the address of this socket.

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.

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

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>

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>

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>

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

Returns the value of the SO_ERROR option.

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

Trait Implementations

impl AsRawFd for UnixDatagram

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Debug for UnixDatagram

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

Formats the value using the given formatter.

impl Evented for UnixDatagram

fn register(
    &self,
    poll: &Poll,
    token: Token,
    events: Ready,
    opts: PollOpt
) -> Result<()>

Register self with the given Poll instance.

fn reregister(
    &self,
    poll: &Poll,
    token: Token,
    events: Ready,
    opts: PollOpt
) -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance

impl FromRawFd for UnixDatagram

unsafe fn from_raw_fd(fd: i32) -> UnixDatagram

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

impl IntoRawFd for UnixDatagram

fn into_raw_fd(self) -> i32

Consumes this object, returning the raw underlying file descriptor.