Struct mio_st::net::TcpStream

pub struct TcpStream { /* private fields */ }

A non-blocking TCP stream between a local socket and a remote socket.

This works much like the TcpStream in the standard library, but the Read and Write implementation don’t block and instead return a WouldBlock error.

Deregistering

TcpStream will deregister itself when dropped.

Examples

use std::time::Duration;

use mio_st::event::{Events, EventedId};
use mio_st::net::TcpStream;
use mio_st::poll::{Poller, PollOption};

let address = "127.0.0.1:8000".parse()?;
let mut stream = TcpStream::connect(address)?;

let mut poller = Poller::new()?;
let mut events = Events::new();

// Register the socket with `Poller`.
poller.register(&mut stream, EventedId(0), TcpStream::INTERESTS, PollOption::Edge)?;

poller.poll(&mut events, None)?;

// The socket might be ready at this point.

Implementations

impl TcpStream

pub const INTERESTS: Interests = Interests::BOTH

The interests to use when registering to receive both readable and writable events.

pub fn connect(address: SocketAddr) -> Result<TcpStream>

Create a new TCP stream and issue a non-blocking connect to the specified address.

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

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

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

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

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

Sets the value for the IP_TTL option on this socket.

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

Gets the value of the IP_TTL option for this socket.

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

Sets the value of the TCP_NODELAY option on this socket.

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

Gets the value of the TCP_NODELAY option on this socket.

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

Receives data on the socket from the remote address to which it is connected, without removing that data from the queue. On success, returns the number of bytes peeked.

Successive calls return the same data. This is accomplished by passing MSG_PEEK as a flag to the underlying recv system call.

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

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

This function will cause all pending and future I/O on the specified portions to return immediately with an appropriate value (see the documentation of Shutdown).

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

Get the value of the SO_ERROR option on this socket.

This will retrieve the stored error in the underlying socket, clearing the field in the process. This can be useful for checking errors between calls.

Trait Implementations

impl AsRawFd for TcpStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl Evented for TcpStream

fn register(
    &mut self,
    poller: &mut Poller,
    id: EventedId,
    interests: Interests,
    opt: PollOption
) -> Result<()>

Register self with the given Poller instance.

fn reregister(
    &mut self,
    poller: &mut Poller,
    id: EventedId,
    interests: Interests,
    opt: PollOption
) -> Result<()>

Reregister self with the given Poller instance.

fn deregister(&mut self, poller: &mut Poller) -> Result<()>

Deregister self from the given Poller instance

impl FromRawFd for TcpStream

unsafe fn from_raw_fd(fd: RawFd) -> TcpStream

The caller must ensure that the stream is in non-blocking mode when using this function.

impl IntoRawFd for TcpStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

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.