Struct cap_async_std::os::unix::net::UnixStream

pub struct UnixStream { /* fields omitted */ }

A Unix stream socket.

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

Note that this UnixStream has no connect method. To create a UnixStream, you must first obtain a Dir containing the path, and then call Dir::connect_unix_stream.

Implementations

impl UnixStream

pub unsafe fn from_std(std: UnixStream) -> Self

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

Safety

async_std::os::unix::net::UnixStream is not sandboxed and may access any address that the host process 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 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 [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

pub 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

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

Attempt to read from the AsyncRead into buf.

pub 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

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

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

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

Attempt to close the object.

pub 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

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

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

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

Attempt to close the object.

pub 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 FromRawFd for UnixStream

pub unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for UnixStream

pub fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.