Struct UnixStream

pub struct UnixStream { /* private fields */ }

UnixStream

Implementations

impl UnixStream

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

Connect UnixStream to a path.

pub async fn connect_addr(addr: SocketAddr) -> Result<Self>

Connects the socket to an address.

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

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

pub fn peer_cred(&self) -> Result<UCred>

Returns effective credentials of the process which called connect or pair.

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

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

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

pub async fn readable(&self, relaxed: bool) -> Result<()>

Wait for read readiness. Note: Do not use it before every io. It is different from other runtimes!

Everytime call to this method may pay a syscall cost. In uring impl, it will push a PollAdd op; in epoll impl, it will use use inner readiness state; if !relaxed, it will call syscall poll after that.

If relaxed, on legacy driver it may return false positive result. If you want to do io by your own, you must maintain io readiness and wait for io ready with relaxed=false.

pub async fn writable(&self, relaxed: bool) -> Result<()>

Wait for write readiness. Note: Do not use it before every io. It is different from other runtimes!

Everytime call to this method may pay a syscall cost. In uring impl, it will push a PollAdd op; in epoll impl, it will use use inner readiness state; if !relaxed, it will call syscall poll after that.

If relaxed, on legacy driver it may return false positive result. If you want to do io by your own, you must maintain io readiness and wait for io ready with relaxed=false.

impl UnixStream

pub fn try_into_poll_io(self) -> Result<UnixStreamPoll, (Error, UnixStream)>

Convert to poll-io style UnixStreamPoll

Trait Implementations

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsReadFd for UnixStream

fn as_reader_fd(&mut self) -> &SharedFdWrapper

Get fd.

impl AsWriteFd for UnixStream

fn as_writer_fd(&mut self) -> &SharedFdWrapper

Get fd.

impl AsyncReadRent for UnixStream

fn read<T: IoBufMut>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Reads bytes from this source into the provided buffer, returning the number of bytes read.

fn readv<T: IoVecBufMut>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Similar to read, but reads data into a slice of buffers.

impl AsyncWriteRent for UnixStream

fn write<T: IoBuf>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Writes the contents of a buffer into this writer, returning the number of bytes written.

fn writev<T: IoVecBuf>( &mut self, buf_vec: T, ) -> impl Future<Output = BufResult<usize, T>>

This function attempts to write the entire contents of buf_vec, but the write may not fully succeed, and it might also result in an error. The bytes will be written starting at the specified offset.

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

Flushes this output stream, ensuring that all buffered content is successfully written to its destination.

fn shutdown(&mut self) -> impl Future<Output = Result<()>>

Shuts down the output stream, ensuring that the value can be cleanly dropped.

impl CancelableAsyncReadRent for UnixStream

async fn cancelable_read<T: IoBufMut>( &mut self, buf: T, c: CancelHandle, ) -> BufResult<usize, T>

Same as read(2)

async fn cancelable_readv<T: IoVecBufMut>( &mut self, buf: T, c: CancelHandle, ) -> BufResult<usize, T>

Same as readv(2)

impl CancelableAsyncWriteRent for UnixStream

async fn cancelable_write<T: IoBuf>( &mut self, buf: T, c: CancelHandle, ) -> BufResult<usize, T>

Same as write(2)

async fn cancelable_writev<T: IoVecBuf>( &mut self, buf_vec: T, c: CancelHandle, ) -> BufResult<usize, T>

Same as writev(2)

async fn cancelable_flush(&mut self, _c: CancelHandle) -> Result<()>

Flush buffered data if needed

async fn cancelable_shutdown(&mut self, _c: CancelHandle) -> Result<()>

Same as shutdown

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl IntoPollIo for UnixStream

type PollIo = UnixStreamPoll

The poll-based io type.

fn try_into_poll_io(self) -> Result<Self::PollIo, (Error, Self)>

Convert a completion-based io to a poll-based io(able to get comp_io back).

fn into_poll_io(self) -> Result<Self::PollIo>

Convert a completion-based io to a poll-based io.

impl IntoRawFd for UnixStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Split for UnixStream

UnixStream is safe to split to two parts