Struct kernel::kasync::net::TcpStream

pub struct TcpStream { /* private fields */ }

A connected TCP socket.

The potentially blocking methods (e.g., TcpStream::read, TcpStream::write) are meant to be used in async contexts.

Examples

async fn echo_server(stream: TcpStream) -> Result {
    let mut buf = [0u8; 1024];
    loop {
        let n = stream.read(&mut buf).await?;
        if n == 0 {
            return Ok(());
        }
        stream.write_all(&buf[..n]).await?;
    }
}

Implementations

impl TcpStream

pub fn read<'a>(
    &'a self,
    buf: &'a mut [u8]
) -> impl Future<Output = Result<usize>> + 'a

Reads data from a connected socket.

Returns a future that when ready indicates the result of the read operation; on success, it contains the number of bytes read, which will be zero if the connection is closed.

pub fn write<'a>(
    &'a self,
    buf: &'a [u8]
) -> impl Future<Output = Result<usize>> + 'a

Writes data to the connected socket.

Returns a future that when ready indicates the result of the write operation; on success, it contains the number of bytes written.

pub async fn write_all<'a>(&'a self, buf: &'a [u8]) -> Result

Writes all the data to the connected socket.

Returns a future that when ready indicates the result of the write operation; on success, it has written all the data.

Methods from Deref<Target = TcpStream>

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

Reads data from a connected socket.

On success, returns the number of bytes read, which will be zero if the connection is closed.

If no data is immediately available for reading, one of two behaviours will occur:

• If block is false, returns crate::error::code::EAGAIN;
• If block is true, blocks until an error occurs, the connection is closed, or some becomes readable.

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

Writes data to the connected socket.

On success, returns the number of bytes written.

If the send buffer of the socket is full, one of two behaviours will occur:

• If block is false, returns crate::error::code::EAGAIN;
• If block is true, blocks until an error occurs or some data is written.

Trait Implementations

impl Deref for TcpStream

type Target = TcpStream

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.