Enum SyncStream 

pub enum SyncStream {
    Tcp(TcpStream),
    Unix(UnixStream),
}

A sync stream that can be either TCP or Unix Domain Socket.

This enum provides a unified interface for different transport mechanisms, allowing Client to work with both TCP and Unix Domain Sockets transparently.

Variants

Tcp(TcpStream)

TCP stream for network connections.

Unix(UnixStream)

Unix Domain Socket stream for local IPC (Unix only).

Implementations

impl SyncStream

pub fn tcp(stream: TcpStream) -> Self

Creates a new TCP stream wrapper.

pub fn unix(stream: UnixStream) -> Self

Creates a new Unix Domain Socket stream wrapper.

pub fn is_tcp(&self) -> bool

Returns true if this is a TCP stream.

pub fn is_unix(&self) -> bool

Returns true if this is a Unix Domain Socket stream.

pub fn set_nodelay(&self, nodelay: bool) -> Result<()>

Sets TCP_NODELAY option (only applicable for TCP streams).

Errors

Returns an io::Error from the underlying std::net::TcpStream::set_nodelay when the socket option cannot be applied. Unix-domain and named-pipe variants are no-ops that always return Ok(()).

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>

Sets read timeout.

Errors

Returns an io::Error from the underlying transport’s set_read_timeout call. On Windows, the named-pipe variant is a no-op that always returns Ok(()).

pub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<()>

Sets write timeout.

Errors

Returns an io::Error from the underlying transport’s set_write_timeout call. On Windows, the named-pipe variant is a no-op that always returns Ok(()).

pub fn local_addr_string(&self) -> String

Returns the local address for TCP streams, or a placeholder for Unix sockets.

pub fn peer_addr_string(&self) -> String

Returns the peer address for TCP streams, or a placeholder for Unix sockets.

pub fn try_clone(&self) -> Result<Self>

Attempts to clone the stream.

Errors

Returns an io::Error from the underlying transport’s try_clone call — typically because the OS refused to duplicate the descriptor.

Trait Implementations

impl Debug for SyncStream

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

Formats the value using the given formatter.

impl Read for SyncStream

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

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

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.

impl Write for SyncStream

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

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

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.