Struct tokio::net::UnixStream

[+] Show declaration

pub struct UnixStream { /* fields omitted */ }

[−] Expand description

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

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

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

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)>[−]

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

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

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

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

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

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

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

Returns the value of the SO_ERROR option.

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

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>)[−]

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)[−]

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

[+] Show hidden undocumented items

fn as_raw_fd(&self) -> RawFd[−]

Extracts the raw file descriptor.

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

[+] Show hidden undocumented items

fn as_ref(&self) -> &UnixStream[−]

Performs the conversion.

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

[+] Show hidden undocumented items

fn as_ref(&self) -> &UnixStream[−]

Performs the conversion.

impl AsRef<UnixStream> for OwnedReadHalf[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &UnixStream[−]

Performs the conversion.

impl AsRef<UnixStream> for OwnedWriteHalf[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &UnixStream[−]

Performs the conversion.

impl AsyncRead for UnixStream[+]

[+] Show hidden undocumented items

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut ReadBuf<'_>
) -> Poll<Result<()>>[−]

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for UnixStream[+]

[+] Show hidden undocumented items

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize>>[−]

Attempt to write bytes from buf into the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>[−]

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool[−]

Determines if this writer has an efficient poll_write_vectored implementation.

fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>[−]

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>[−]

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl Debug for UnixStream[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl TryFrom<UnixStream> for UnixStream[+]

type Error = Error

The type returned in the event of a conversion error.

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

Consumes stream, returning the tokio I/O object.

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