Struct lunatic::net::TcpStream

pub struct TcpStream { /* private fields */ }

A TCP connection.

A TcpStream can be created by connecting to an endpoint or by accepting an incoming connection.

TcpStream is a bidirectional stream that implements traits Read and Write.

Cloning a TcpStream creates another handle to the same socket. The socket will be closed when all handles to it are dropped.

The Transmission Control Protocol is specified in IETF RFC 793.

Implementations

impl TcpStream

pub fn connect<A>(addr: A) -> Result<Self>where A: ToSocketAddrs,

Creates a TCP connection to the specified address.

This method will create a new TCP socket and attempt to connect it to the provided addr,

If addr yields multiple addresses, connecting will be attempted with each of the addresses until connecting to one succeeds. If none of the addresses result in a successful connection, the error from the last connect attempt is returned.

pub fn connect_timeout<A>(addr: A, timeout: Duration) -> Result<Self>where A: ToSocketAddrs,

Same as TcpStream::connect, but only waits for the duration of timeout to connect.

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

Returns the remote address this socket is connected to.

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

Sets write timeout for TcpStream

This method will change the timeout for everyone holding a reference to the TcpStream Once a timeout is set, it can be removed by sending None

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

Gets write timeout for TcpStream

This method retrieves the write timeout duration of the TcpStream if any

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

Sets read timeout for TcpStream

This method will change the timeout for everyone holding a reference to the TcpStream Once a timeout is set, it can be removed by sending None

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

Gets read timeout for TcpStream

This method retrieves the read timeout duration of the TcpStream if any

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

Sets peek timeout for TcpStream

This method will change the timeout for everyone holding a reference to the TcpStream Once a timeout is set, it can be removed by sending None

pub fn peek_timeout(&self) -> Option<Duration>

Gets peek timeout for TcpStream

This method retrieves the peek timeout duration of the TcpStream if any

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

Peek value on the tcp stream without removing it from internal buffer. Any subsequent calls to peek will read from the internal buffer and only calls to read will consume the buffered data

Trait Implementations

impl Clone for TcpStream

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TcpStream

fn deserialize<D>(deserializer: D) -> Result<TcpStream, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for TcpStream

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

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 write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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

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

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

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.