[][src]Struct actix_rt::net::UnixDatagram

pub struct UnixDatagram { /* fields omitted */ }

An I/O object representing a Unix datagram socket.

Methods

impl UnixDatagram[src]

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

Creates a new UnixDatagram bound to the specified path.

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

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) -> Result<UnixDatagram, Error>[src]

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.

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

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

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

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 async fn send(&'_ mut self, buf: &'_ [u8]) -> Result<usize, Error>[src]

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

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

Receives data from the socket.

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

Sends data on the socket to the specified address.

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

Receives data from the socket.

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

Returns the local address that this socket is bound to.

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

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>[src]

Returns the value of the SO_ERROR option.

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

Shuts 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[src]

impl Debug for UnixDatagram[src]

impl TryFrom<UnixDatagram> for UnixDatagram[src]

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>
[src]

Consumes stream, returning the tokio I/O object.

This is equivalent to UnixDatagram::from_std(stream).

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.