Struct tokio::net::UnixStream

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.

Methods

impl UnixStream

pub fn connect<P>(path: P) -> impl Future<Output = Result<UnixStream, Error>> 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,
    handle: &Handle
) -> Result<UnixStream, Error>

Consumes a UnixStream in the standard library and returns a nonblocking UnixStream from this crate.

The returned stream will be associated with the given event loop specified by handle and is ready to perform I/O.

pub fn pair() -> Result<(UnixStream, UnixStream), Error>

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

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

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

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

pub fn peer_cred(&self) -> Result<UCred, Error>

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

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

Returns the value of the SO_ERROR option.

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

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(self) -> (UnixStreamReadHalf, UnixStreamWriteHalf)

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

See the module level documenation of split for more details.

pub fn split_mut(&mut self) -> (UnixStreamReadHalfMut, UnixStreamWriteHalfMut)

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

See the module level documenation of split for more details.

Trait Implementations

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl<'_> AsRef<UnixStream> for UnixStreamWriteHalfMut<'_>

fn as_ref(&self) -> &UnixStream

Performs the conversion.

impl AsRef<UnixStream> for UnixStreamReadHalf

fn as_ref(&self) -> &UnixStream

Performs the conversion.

impl AsRef<UnixStream> for UnixStreamWriteHalf

fn as_ref(&self) -> &UnixStream

Performs the conversion.

impl<'_> AsRef<UnixStream> for UnixStreamReadHalfMut<'_>

fn as_ref(&self) -> &UnixStream

Performs the conversion.

impl AsyncRead for UnixStream

unsafe fn prepare_uninitialized_buffer(&self, &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

fn poll_read(
    self: Pin<&mut UnixStream>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_buf<B>(
    self: Pin<&mut UnixStream>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: BufMut, 

Pull some bytes from this source into the specified BufMut, returning how many bytes were read.

impl TryFrom<UnixStream> for UnixStream

type Error = Error

The type returned in the event of a conversion error.

fn try_from(stream: UnixStream) -> Result<UnixStream, Error>

Consumes stream, returning the tokio I/O object.

This is equivalent to UnixStream::from_std(stream, &Handle::default()).

impl AsyncWrite for UnixStream

fn poll_write(
    self: Pin<&mut UnixStream>,
    cx: &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush(
    self: Pin<&mut UnixStream>,
    &mut Context
) -> Poll<Result<(), Error>>

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

fn poll_shutdown(
    self: Pin<&mut UnixStream>,
    &mut Context
) -> Poll<Result<(), Error>>

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

fn poll_write_buf<B>(
    self: Pin<&mut UnixStream>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: Buf, 

Write a Buf into this value, returning how many bytes were written.

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.