Struct mio::net::TcpStream

pub struct TcpStream { /* fields omitted */ }

This is supported on crate features tcp or udp only.

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

The socket will be closed when the value is dropped.

Examples

let address: SocketAddr = "127.0.0.1:0".parse()?;
let listener = TcpListener::bind(address)?;
use mio::{Events, Interest, Poll, Token};
use mio::net::TcpStream;
use std::time::Duration;

let mut stream = TcpStream::connect(listener.local_addr()?)?;

let mut poll = Poll::new()?;
let mut events = Events::with_capacity(128);

// Register the socket with `Poll`
poll.registry().register(&mut stream, Token(0), Interest::WRITABLE)?;

poll.poll(&mut events, Some(Duration::from_millis(100)))?;

// The socket might be ready at this point

Implementations

impl TcpStream

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

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

pub fn from_std(stream: TcpStream) -> TcpStream

This is supported on (crate features tcp or udp) and crate feature tcp only.

Creates a new TcpStream from a standard net::TcpStream.

This function is intended to be used to wrap a TCP stream from the standard library in the Mio equivalent. The conversion assumes nothing about the underlying stream; it is left up to the user to set it in non-blocking mode.

Note

The TCP stream here will not have connect called on it, so it should already be connected via some other means (be it manually, or the standard library).

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

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

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

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

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

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 set_nodelay(&self, nodelay: bool) -> Result<()>

This is supported on (crate features tcp or udp) and crate feature tcp only.

Sets the value of the TCP_NODELAY option on this socket.

If set, this option disables the Nagle algorithm. This means that segments are always sent as soon as possible, even if there is only a small amount of data. When not set, data is buffered until there is a sufficient amount to send out, thereby avoiding the frequent sending of small packets.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to set nodelay on an unconnected TcpStream is undefined behavior.

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

Gets the value of the TCP_NODELAY option on this socket.

For more information about this option, see set_nodelay.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to get nodelay on an unconnected TcpStream is undefined behavior.

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

Sets the value for the IP_TTL option on this socket.

This value sets the time-to-live field that is used in every packet sent from this socket.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to set ttl on an unconnected TcpStream is undefined behavior.

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to get ttl on an unconnected TcpStream is undefined behavior.

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

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.

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

This is supported on (crate features tcp or udp) and crate feature tcp only.

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.

Trait Implementations

impl AsRawSocket for TcpStream

fn as_raw_socket(&self) -> RawSocket

Extracts the underlying raw socket from this object.

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl FromRawSocket for TcpStream

unsafe fn from_raw_socket(socket: RawSocket) -> TcpStream

Converts a RawSocket to a TcpStream.

Notes

The caller is responsible for ensuring that the socket is in non-blocking mode.

impl IntoRawSocket for TcpStream

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket.

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>

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.

unsafe fn initializer(&self) -> Initializer

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

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

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.

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 by_ref(&mut self) -> &mut Self

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a> Read for &'a 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>

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.

unsafe fn initializer(&self) -> Initializer

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

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

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.

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 by_ref(&mut self) -> &mut Self

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Source for TcpStream

fn register(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Register self with the given Registry instance.

fn reregister(
    &mut self,
    registry: &Registry,
    token: Token,
    interests: Interest
) -> Result<()>

Re-register self with the given Registry instance.

fn deregister(&mut self, registry: &Registry) -> Result<()>

Deregister self from the given Registry instance.

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 Writeer 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 Self

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

impl<'a> Write for &'a 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 Writeer 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 Self

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