Struct tokio::net::UnixStream[][src]

pub struct UnixStream { /* fields omitted */ }

A structure representing a connected Unix socket.

This socket can be connected directly with UnixStream::connect or accepted from a listener with UnixListener::incoming. Additionally, a pair of anonymous Unix sockets can be created with UnixStream::pair.

Implementations

impl UnixStream[src]

pub async fn connect<P>(path: P) -> Result<UnixStream> where
    P: AsRef<Path>, 
[src]

Connects to the socket named by path.

This function will create a new Unix socket and connect to the path specified, associating the returned stream with the default event loop’s handle.

pub fn from_std(stream: UnixStream) -> Result<UnixStream>[src]

Creates new UnixStream from a std::os::unix::net::UnixStream.

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

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 Runtime::enter function.

pub fn pair() -> Result<(UnixStream, UnixStream)>[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 local_addr(&self) -> Result<SocketAddr>[src]

Returns the socket address of the local half of this connection.

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

Returns the socket address of the remote half of this connection.

pub fn peer_cred(&self) -> Result<UCred>[src]

Returns effective credentials of the process which called connect or pair.

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

Returns the value of the SO_ERROR option.

pub fn shutdown(&self, how: Shutdown) -> Result<()>[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).

pub fn split<'a>(&'a mut self) -> (ReadHalf<'a>, WriteHalf<'a>)[src]

Split a UnixStream into a read half and a write half, which can be used to read and write the stream concurrently.

This method is more efficient than into_split, but the halves cannot be moved into independently spawned tasks.

pub fn into_split(self) -> (OwnedReadHalf, OwnedWriteHalf)[src]

Splits a UnixStream into a read half and a write half, which can be used to read and write the stream concurrently.

Unlike split, the owned halves can be moved to separate tasks, however this comes at the cost of a heap allocation.

Note: Dropping the write half will shut down the write half of the stream. This is equivalent to calling shutdown(Write) on the UnixStream.

Trait Implementations

impl AsRawFd for UnixStream[src]

impl AsRef<UnixStream> for ReadHalf<'_>[src]

impl AsRef<UnixStream> for WriteHalf<'_>[src]

impl AsRef<UnixStream> for OwnedReadHalf[src]

impl AsRef<UnixStream> for OwnedWriteHalf[src]

impl AsyncRead for UnixStream[src]

impl AsyncWrite for UnixStream[src]

impl Debug for UnixStream[src]

impl TryFrom<UnixStream> for UnixStream[src]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(stream: UnixStream) -> Result<Self>[src]

Consumes stream, returning the tokio I/O object.

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

Auto Trait Implementations

impl !RefUnwindSafe for UnixStream

impl Send for UnixStream

impl Sync for UnixStream

impl Unpin for UnixStream

impl !UnwindSafe for UnixStream

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.