Struct interprocess::nonblocking::local_socket::LocalSocketStream

pub struct LocalSocketStream { /* fields omitted */ }

This is supported on crate feature nonblocking only.

An asynchronous local socket byte stream, obtained eiter from LocalSocketListener or by connecting to an existing local socket.

Example

use futures::io::{BufReader, AsyncBufReadExt, AsyncWriteExt};
use interprocess::nonblocking::local_socket::*;

// Replace the path as necessary on Windows.
let mut conn = LocalSocketStream::connect("/tmp/example.sock")
    .await?;
conn.write_all(b"Hello from client!\n").await?;
let mut conn = BufReader::new(conn);
let mut buffer = String::new();
conn.read_line(&mut buffer).await?;
println!("Server answered: {}", buffer);

Implementations

impl LocalSocketStream

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

Connects to a remote local socket server.

Trait Implementations

impl AsyncRead for LocalSocketStream

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

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, Error>>

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, Error>>

Attempt to write bytes from buf into the object.

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

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

Attempt to close the object.

pub fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for LocalSocketStream

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

Formats the value using the given formatter.