Struct UnixStream

pub struct UnixStream { /* private fields */ }

A Unix stream socket.

This corresponds to async_std::os::unix::net::UnixStream.

This UnixStream has no connect method. To create a UnixStream, first obtain a Dir containing the path, and then call Dir::connect_unix_stream.

Implementations

impl UnixStream

pub fn from_std(std: UnixStream) -> Self

Constructs a new instance of Self from the given async_std::os::unix::net::UnixStream.

This grants access the resources the async_std::os::unix::net::UnixStream instance already has access to.

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

Creates an unnamed pair of connected sockets.

This corresponds to async_std::os::unix::net::UnixStream::pair.

TODO: should this require a capability?

pub fn local_addr(&self) -> Result<SocketAddr>

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

This corresponds to async_std::os::unix::net::UnixStream::local_addr.

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

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

This corresponds to async_std::os::unix::net::UnixStream::peer_addr.

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

Shuts down the read, write, or both halves of this connection.

This corresponds to async_std::os::unix::net::UnixStream::shutdown.

Trait Implementations

impl AsFd for UnixStream

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Clone for UnixStream

fn clone(&self) -> UnixStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl From<OwnedFd> for UnixStream

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<UnixStream> for OwnedFd

fn from(stream: UnixStream) -> OwnedFd

Converts to this type from the input type.

impl FromRawFd for UnixStream

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for UnixStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl AsyncRead for &UnixStream

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncRead for UnixStream

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

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

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

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

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

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

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.