Struct cancellable_io::TcpStream

pub struct TcpStream { /* fields omitted */ }

A TCP stream between a local and a remote socket.

The socket will be closed when the value is dropped.

The read and write methods can be interrupted using the Canceller object created with the stream.

Otherwise similar to std::net::TcpStream.

Methods

impl TcpStream

pub fn connect<A: ToSocketAddrs>(address: A) -> Result<(Self, Canceller)>

Creates a new TCP stream with an object used to cancel read/write operations, and connects it to a remote address.

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the socket address of the remote peer of this TCP connection.

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the socket address of the local half of this TCP connection.

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

Shuts down the read, write, or both halves of this connection.

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

Creates a new independently owned handle to the underlying socket. The Cancellers associated with the original object and its clone are also independent.

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

Sets the read timeout.

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

Sets the write timeout.

pub fn read_timeout(&self) -> Result<Option<Duration>>

Gets the read timeout.

pub fn write_timeout(&self) -> Result<Option<Duration>>

Gets the write timeout.

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

Sets the value of the TCP_NODELAY option on this socket.

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

Gets the value of the TCP_NODELAY option for this socket.

pub fn set_ttl(&self, ttl: u32) -> Result<()>

Sets the value for the IP_TTL option on this socket.

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

Gets the value for the IP_TTL option for this socket.

pub fn take_error(&self) -> Result<Option<Error>>

Gets the value of the SO_ERROR option for this socket.

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Moves this TCP stream into or out of nonblocking mode.

Trait Implementations

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl Read for TcpStream

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

Reads data from the socket. This operation can be cancelled by the associated Canceller object.

default fn read_vectored(
    &mut self,
    bufs: &mut [IoVecMut]
) -> Result<usize, Error>

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

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

unsafe default fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

default fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for TcpStream

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

Writes data to the socket. This operation can be cancelled by the associated Canceller object.

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

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

default fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>

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

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

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

Attempts to write an entire buffer into this writer.

default fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

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

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

Creates a "by reference" adaptor for this instance of Write.