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.

For now, this is a synchronous function.

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

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for UnixStream

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

Attempts to read from the AsyncRead into buf.

unsafe fn prepare_uninitialized_buffer(
    &self,
    buf: &mut [MaybeUninit<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_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: BufMut, 

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

impl AsyncWrite for UnixStream

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_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

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.

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

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

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl DequeueFd for UnixStream

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

Dequeue a previouly transmitted RawFd.

impl EnqueueFd for UnixStream

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

Enqueue fd for later tranmission to a different process.

impl PinnedDrop for UnixStream

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.

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.

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