Struct fd_queue::tokio::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.

Implementations

impl UnixStream

pub async fn connect(path: impl AsRef<Path>) -> Result<UnixStream>

Connects to the socket named by path.

This function will create a new socket and connect the the path specifed, associating the returned stream with the default event loop's handle.

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

Creates an unnamed pair of conntected sockets.

This function will create an unnamed pair of interconnected Unix sockets for communicating back and forth between one another. Each socket will be associted 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 conneciton.

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

Trait Implementations

impl AsRawFd for UnixStream

pub fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for UnixStream

pub 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

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

Attempt to write bytes from buf into the object.

pub fn poll_flush(
    self: Pin<&mut Self>,
    _cx: &mut Context<'_>
) -> Poll<Result<()>>

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

pub fn poll_shutdown(
    self: Pin<&mut Self>,
    _cx: &mut Context<'_>
) -> Poll<Result<()>>

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

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

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

pub fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl DequeueFd for UnixStream

pub fn dequeue(&mut self) -> Option<RawFd>

Dequeue a previouly transmitted RawFd.

impl EnqueueFd for UnixStream

pub fn enqueue(&mut self, fd: &impl AsRawFd) -> Result<(), QueueFullError>

Enqueue fd for later tranmission to a different process.

impl PinnedDrop for UnixStream

pub unsafe fn drop(self: Pin<&mut Self>)

impl TryFrom<UnixStream> for UnixStream

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(inner: UnixStream) -> Result<UnixStream>

Performs the conversion.

impl TryFrom<UnixStream> for UnixStream

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(inner: StdUnixStream) -> Result<Self, Self::Error>

Performs the conversion.

impl<'pin> Unpin for UnixStream where
    __UnixStream<'pin>: Unpin, 

impl UnsafeUnpin for UnixStream