Struct mtcp_rs::TcpStream

pub struct TcpStream { /* private fields */ }

A TCP stream between a local and a remote socket, akin to std::net::TcpStream

All I/O operations provided by mtcp::TcpStream are “blocking” by default, but – unlike the std::net implementation – proper timeout and cancellation support is available. Each mtcp::TcpStream is tied to an mtcp::TcpManager instance.

A new TCP stream is created by connect()ing to a remote host, or initialized from() an existing mtcp::TcpConnection.

If the timeout parameter was set to Some(Duration) and if the I/O operation does not complete before the specified timeout period expires, then the pending I/O operation will fail as soon as possible with an TcpError::TimedOut error.

Function like Read::read() and Write::write(), which do not have an explicit timeout parameter, implicitly use the timeouts that have been set up via the set_default_timeouts() function. Initially, these timeouts are disabled.

Implementations

impl TcpStream

pub fn from(manager: &Rc<TcpManager>, connection: TcpConnection) -> Result<Self>

pub fn set_default_timeouts(
    &mut self,
    timeout_rd: Option<Duration>,
    timeout_wr: Option<Duration>
)

pub fn shutdown(&self, how: Shutdown) -> Result<()>

pub fn connect(
    manager: &Rc<TcpManager>,
    addr: SocketAddr,
    timeout: Option<Duration>
) -> Result<Self>

pub fn read_timeout(
    &mut self,
    buffer: &mut [u8],
    timeout: Option<Duration>
) -> Result<usize>

pub fn read_all_timeout<F>(
    &mut self,
    buffer: &mut Vec<u8>,
    timeout: Option<Duration>,
    chunk_size: Option<NonZeroUsize>,
    fn_complete: F
) -> Result<()>where
    F: Fn(&[u8]) -> bool,

pub fn write_timeout(
    &mut self,
    buffer: &[u8],
    timeout: Option<Duration>
) -> Result<usize>

pub fn write_all_timeout(
    &mut self,
    buffer: &[u8],
    timeout: Option<Duration>
) -> Result<()>

Trait Implementations

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl Drop for TcpStream

fn drop(&mut self)

Executes the destructor for this type.

impl Read for TcpStream

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, Global>) -> Result<usize, Error>

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

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

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

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

Read 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)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adaptor 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.

impl Write for TcpStream

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

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

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

Flush 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, fmt: Arguments<'_>) -> Result<(), Error>

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

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

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