Struct LocalSocketStream

pub struct LocalSocketStream { /* private fields */ }

Available on crate feature tokio_support only.

A Tokio-based local socket byte stream, obtained eiter from LocalSocketListener or by connecting to an existing local socket.

Examples

• Basic client

Implementations

impl LocalSocketStream

pub async fn connect<'a>(name: impl ToLocalSocketName<'a>) -> Result<Self>

Connects to a remote local socket server.

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

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

pub fn peer_pid(&self) -> Result<u32>

Retrieves the identifier of the process on the opposite end of the local socket connection.

Platform-specific behavior

macOS and iOS

Not supported by the OS, will always generate an error at runtime.

Trait Implementations

impl AsRawFd for LocalSocketStream

fn as_raw_fd(&self) -> c_int

Extracts the raw file descriptor.

impl AsyncRead for LocalSocketStream

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 LocalSocketStream

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

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.

impl Debug for LocalSocketStream

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

Formats the value using the given formatter.