Struct async_std::os::unix::net::UnixStream

pub struct UnixStream { /* fields omitted */ }

This is supported on Unix only.

A Unix stream socket.

This type is an async version of std::os::unix::net::UnixStream.

Examples

use async_std::os::unix::net::UnixStream;
use async_std::prelude::*;

let mut stream = UnixStream::connect("/tmp/socket").await?;
stream.write_all(b"hello world").await?;

let mut response = Vec::new();
stream.read_to_end(&mut response).await?;

Implementations

impl UnixStream

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

Connects to the socket to the specified address.

Examples

use async_std::os::unix::net::UnixStream;

let stream = UnixStream::connect("/tmp/socket").await?;

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

Creates an unnamed pair of connected sockets.

Returns two streams which are connected to each other.

Examples

use async_std::os::unix::net::UnixStream;

let stream = UnixStream::pair()?;

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

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

Examples

use async_std::os::unix::net::UnixStream;

let stream = UnixStream::connect("/tmp/socket").await?;
let addr = stream.local_addr()?;

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

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

Examples

use async_std::os::unix::net::UnixStream;

let stream = UnixStream::connect("/tmp/socket").await?;
let peer = stream.peer_addr()?;

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

use async_std::os::unix::net::UnixStream;
use std::net::Shutdown;

let stream = UnixStream::connect("/tmp/socket").await?;
stream.shutdown(Shutdown::Both)?;

Trait Implementations

impl AsRawFd for UnixStream

pub fn as_raw_fd(&self) -> RawFd

This is supported on Unix only.

Extracts the raw file descriptor.

impl Clone for UnixStream

pub fn clone(&self) -> UnixStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl From<UnixStream> for UnixStream

pub fn from(stream: StdUnixStream) -> UnixStream

Converts a std::os::unix::net::UnixStream into its asynchronous equivalent.

impl FromRawFd for UnixStream

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

This is supported on Unix only.

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

impl IntoRawFd for UnixStream

pub fn into_raw_fd(self) -> RawFd

This is supported on Unix only.

Consumes this object, returning the raw underlying file descriptor.

impl Read 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.

pub fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads some bytes from the byte stream.

pub fn read_vectored<'a>(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Like read, except that it reads into a slice of buffers.

pub fn read_to_end<'a>(
    &'a mut self,
    buf: &'a mut Vec<u8>
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream.

pub fn read_to_string<'a>(
    &'a mut self,
    buf: &'a mut String
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream and appends them into a string.

pub fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Reads the exact number of bytes required to fill buf.

pub fn take(self, limit: u64) -> Take<Self> where
    Self: Sized, 

Creates an adaptor which will read at most limit bytes from it.

pub fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self> where
    Self: Sized, 

Transforms this Read instance to a Stream over its bytes.

pub fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
    Self: Sized, 

Creates an adaptor which will chain this stream with another.

impl<'_> Read 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.

pub fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads some bytes from the byte stream.

pub fn read_vectored<'a>(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Like read, except that it reads into a slice of buffers.

pub fn read_to_end<'a>(
    &'a mut self,
    buf: &'a mut Vec<u8>
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream.

pub fn read_to_string<'a>(
    &'a mut self,
    buf: &'a mut String
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream and appends them into a string.

pub fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Reads the exact number of bytes required to fill buf.

pub fn take(self, limit: u64) -> Take<Self> where
    Self: Sized, 

Creates an adaptor which will read at most limit bytes from it.

pub fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self> where
    Self: Sized, 

Transforms this Read instance to a Stream over its bytes.

pub fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
    Self: Sized, 

Creates an adaptor which will chain this stream with another.

impl Write 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.

pub fn write<'a>(&'a mut self, buf: &'a [u8]) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Writes some bytes into the byte stream.

pub fn flush(&mut self) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Flushes the stream to ensure that all buffered contents reach their destination.

pub fn write_vectored<'a>(
    &'a mut self,
    bufs: &'a [IoSlice<'a>]
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

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

pub fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Writes an entire buffer into the byte stream.

pub fn write_fmt<'a>(&'a mut self, fmt: Arguments<'_>) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Writes a formatted string into this writer, returning any error encountered.

impl<'_> Write 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.

pub fn write<'a>(&'a mut self, buf: &'a [u8]) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Writes some bytes into the byte stream.

pub fn flush(&mut self) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Flushes the stream to ensure that all buffered contents reach their destination.

pub fn write_vectored<'a>(
    &'a mut self,
    bufs: &'a [IoSlice<'a>]
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

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

pub fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Writes an entire buffer into the byte stream.

pub fn write_fmt<'a>(&'a mut self, fmt: Arguments<'_>) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Writes a formatted string into this writer, returning any error encountered.