Struct UnixStream 

pub struct UnixStream { /* private fields */ }

Available on crate feature net only.

A Unix stream between two local sockets on Windows & WSL.

A Unix stream can either be created by connecting to an endpoint, via the connect method, or by accepting a connection from a listener.

Examples

use compio_io::AsyncWrite;
use compio_net::UnixStream;

// Connect to a peer
let mut stream = UnixStream::connect("unix-server.sock").await.unwrap();

// Write some data.
stream.write("hello world!").await.unwrap();

Implementations

impl UnixStream

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

Opens a Unix connection to the specified file path. There must be a UnixListener or equivalent listening on the corresponding Unix domain socket to successfully connect and return a UnixStream.

pub async fn connect_addr(addr: &SockAddr) -> Result<UnixStream, Error>

Opens a Unix connection to the specified address. There must be a UnixListener or equivalent listening on the corresponding Unix domain socket to successfully connect and return a UnixStream.

pub async fn connect_with_options( addr: &SockAddr, options: &SocketOpts, ) -> Result<UnixStream, Error>

Opens a Unix connection to the specified address with SocketOpts. There must be a UnixListener or equivalent listening on the corresponding Unix domain socket to successfully connect and return a UnixStream.

pub fn from_std(stream: UnixStream) -> Result<UnixStream, Error>

Available on Unix only.

Creates new UnixStream from a std::os::unix::net::UnixStream.

pub fn close(self) -> impl Future<Output = Result<(), Error>>

Close the socket. If the returned future is dropped before polling, the socket won’t be closed.

pub fn peer_addr(&self) -> Result<SockAddr, Error>

Returns the socket path of the remote peer of this connection.

pub fn local_addr(&self) -> Result<SockAddr, Error>

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

pub fn split(&self) -> (ReadHalf<'_, UnixStream>, WriteHalf<'_, UnixStream>)

Splits a UnixStream into a read half and a write half, which can be used to read and write the stream concurrently.

This method is more efficient than into_split, but the halves cannot be moved into independently spawned tasks.

pub fn into_split( self, ) -> (OwnedReadHalf<UnixStream>, OwnedWriteHalf<UnixStream>)

Splits a UnixStream into a read half and a write half, which can be used to read and write the stream concurrently.

Unlike split, the owned halves can be moved to separate tasks, however this comes at the cost of a heap allocation.

pub fn to_poll_fd(&self) -> Result<PollFd<Socket>, Error>

Create PollFd from inner socket.

pub fn into_poll_fd(self) -> Result<PollFd<Socket>, Error>

Create PollFd from inner socket.

Trait Implementations

impl AsFd for UnixStream

Available on Unix only.

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

Borrows the file descriptor.

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl AsyncRead for &UnixStream

async fn read<B>(&mut self, buf: B) -> BufResult<usize, B>

where B: IoBufMut,

Read some bytes from this source into the IoBufMut buffer and return a BufResult, consisting of the buffer and a usize indicating how many bytes were read.

async fn read_vectored<V>(&mut self, buf: V) -> BufResult<usize, V>

where V: IoVectoredBufMut,

Like read, except that it reads into a type implements IoVectoredBufMut.

impl AsyncRead for UnixStream

async fn read<B>(&mut self, buf: B) -> BufResult<usize, B>

where B: IoBufMut,

Read some bytes from this source into the IoBufMut buffer and return a BufResult, consisting of the buffer and a usize indicating how many bytes were read.

async fn read_vectored<V>(&mut self, buf: V) -> BufResult<usize, V>

where V: IoVectoredBufMut,

Like read, except that it reads into a type implements IoVectoredBufMut.

impl AsyncReadManaged for &UnixStream

type Buffer<'a> = BorrowedBuffer<'a>

Filled buffer type

type BufferPool = BufferPool

Buffer pool type

async fn read_managed<'a>( &mut self, buffer_pool: &'a <&UnixStream as AsyncReadManaged>::BufferPool, len: usize, ) -> Result<<&UnixStream as AsyncReadManaged>::Buffer<'a>, Error>

Read some bytes from this source with Self::BufferPool and return a Self::Buffer.

impl AsyncReadManaged for UnixStream

type Buffer<'a> = BorrowedBuffer<'a>

Filled buffer type

type BufferPool = BufferPool

Buffer pool type

async fn read_managed<'a>( &mut self, buffer_pool: &'a <UnixStream as AsyncReadManaged>::BufferPool, len: usize, ) -> Result<<UnixStream as AsyncReadManaged>::Buffer<'a>, Error>

Read some bytes from this source with Self::BufferPool and return a Self::Buffer.

impl AsyncWrite for &UnixStream

async fn write<T>(&mut self, buf: T) -> BufResult<usize, T>

where T: IoBuf,

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn write_vectored<T>(&mut self, buf: T) -> BufResult<usize, T>

where T: IoVectoredBuf,

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

async fn flush(&mut self) -> Result<(), Error>

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

async fn shutdown(&mut self) -> Result<(), Error>

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

impl AsyncWrite for UnixStream

async fn write<T>(&mut self, buf: T) -> BufResult<usize, T>

where T: IoBuf,

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn write_vectored<T>(&mut self, buf: T) -> BufResult<usize, T>

where T: IoVectoredBuf,

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

async fn flush(&mut self) -> Result<(), Error>

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

async fn shutdown(&mut self) -> Result<(), Error>

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

impl Clone for UnixStream

fn clone(&self) -> UnixStream

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl FromRawFd for UnixStream

Available on Unix only.

unsafe fn from_raw_fd(fd: i32) -> UnixStream

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

impl<'a> Splittable for &'a UnixStream

type ReadHalf = ReadHalf<'a, UnixStream>

The type of the read half, which normally implements AsyncRead or AsyncReadAt.

type WriteHalf = WriteHalf<'a, UnixStream>

The type of the write half, which normally implements AsyncWrite or AsyncWriteAt.

fn split( self, ) -> (<&'a UnixStream as Splittable>::ReadHalf, <&'a UnixStream as Splittable>::WriteHalf)

Consumes self and returns a tuple containing separate read and write halves.

impl Splittable for UnixStream

type ReadHalf = OwnedReadHalf<UnixStream>

The type of the read half, which normally implements AsyncRead or AsyncReadAt.

type WriteHalf = OwnedWriteHalf<UnixStream>

The type of the write half, which normally implements AsyncWrite or AsyncWriteAt.

fn split( self, ) -> (<UnixStream as Splittable>::ReadHalf, <UnixStream as Splittable>::WriteHalf)

Consumes self and returns a tuple containing separate read and write halves.

impl ToSharedFd<Socket> for UnixStream

fn to_shared_fd(&self) -> SharedFd<Socket>

Return a cloned SharedFd.