[−][src]Struct cueball_tcp_stream_connection::TcpStreamWrapper
Fields
stream: Option<TcpStream>
Methods
impl TcpStreamWrapper
[src]
Methods from Deref<Target = TcpStream>
pub fn peer_addr(&self) -> Result<SocketAddr, Error>
1.0.0[src]
Returns the socket address of the remote peer of this TCP connection.
Examples
use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4, TcpStream}; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); assert_eq!(stream.peer_addr().unwrap(), SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080)));
pub fn local_addr(&self) -> Result<SocketAddr, Error>
1.0.0[src]
Returns the socket address of the local half of this TCP connection.
Examples
use std::net::{IpAddr, Ipv4Addr, TcpStream}; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); assert_eq!(stream.local_addr().unwrap().ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
pub fn shutdown(&self, how: Shutdown) -> Result<(), Error>
1.0.0[src]
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
).
Platform-specific behavior
Calling this function multiple times may result in different behavior,
depending on the operating system. On Linux, the second call will
return Ok(())
, but on macOS, it will return ErrorKind::NotConnected
.
This may change in the future.
Examples
use std::net::{Shutdown, TcpStream}; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.shutdown(Shutdown::Both).expect("shutdown call failed");
pub fn try_clone(&self) -> Result<TcpStream, Error>
1.0.0[src]
Creates a new independently owned handle to the underlying socket.
The returned TcpStream
is a reference to the same stream that this
object references. Both handles will read and write the same stream of
data, and options set on one stream will be propagated to the other
stream.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); let stream_clone = stream.try_clone().expect("clone failed...");
pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<(), Error>
1.4.0[src]
Sets the read timeout to the timeout specified.
If the value specified is None
, then read
calls will block
indefinitely. An Err
is returned if the zero Duration
is
passed to this method.
Platform-specific behavior
Platforms may return a different error code whenever a read times out as
a result of setting this option. For example Unix typically returns an
error of the kind WouldBlock
, but Windows may return TimedOut
.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_read_timeout(None).expect("set_read_timeout call failed");
An Err
is returned if the zero Duration
is passed to this
method:
use std::io; use std::net::TcpStream; use std::time::Duration; let stream = TcpStream::connect("127.0.0.1:8080").unwrap(); let result = stream.set_read_timeout(Some(Duration::new(0, 0))); let err = result.unwrap_err(); assert_eq!(err.kind(), io::ErrorKind::InvalidInput)
pub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<(), Error>
1.4.0[src]
Sets the write timeout to the timeout specified.
If the value specified is None
, then write
calls will block
indefinitely. An Err
is returned if the zero Duration
is
passed to this method.
Platform-specific behavior
Platforms may return a different error code whenever a write times out
as a result of setting this option. For example Unix typically returns
an error of the kind WouldBlock
, but Windows may return TimedOut
.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_write_timeout(None).expect("set_write_timeout call failed");
An Err
is returned if the zero Duration
is passed to this
method:
use std::io; use std::net::TcpStream; use std::time::Duration; let stream = TcpStream::connect("127.0.0.1:8080").unwrap(); let result = stream.set_write_timeout(Some(Duration::new(0, 0))); let err = result.unwrap_err(); assert_eq!(err.kind(), io::ErrorKind::InvalidInput)
pub fn read_timeout(&self) -> Result<Option<Duration>, Error>
1.4.0[src]
Returns the read timeout of this socket.
If the timeout is None
, then read
calls will block indefinitely.
Platform-specific behavior
Some platforms do not provide access to the current timeout.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_read_timeout(None).expect("set_read_timeout call failed"); assert_eq!(stream.read_timeout().unwrap(), None);
pub fn write_timeout(&self) -> Result<Option<Duration>, Error>
1.4.0[src]
Returns the write timeout of this socket.
If the timeout is None
, then write
calls will block indefinitely.
Platform-specific behavior
Some platforms do not provide access to the current timeout.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_write_timeout(None).expect("set_write_timeout call failed"); assert_eq!(stream.write_timeout().unwrap(), None);
pub fn peek(&self, buf: &mut [u8]) -> Result<usize, Error>
1.18.0[src]
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.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8000") .expect("couldn't bind to address"); let mut buf = [0; 10]; let len = stream.peek(&mut buf).expect("peek failed");
pub fn set_nodelay(&self, nodelay: bool) -> Result<(), Error>
1.9.0[src]
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.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_nodelay(true).expect("set_nodelay call failed");
pub fn nodelay(&self) -> Result<bool, Error>
1.9.0[src]
Gets the value of the TCP_NODELAY
option on this socket.
For more information about this option, see set_nodelay
.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_nodelay(true).expect("set_nodelay call failed"); assert_eq!(stream.nodelay().unwrap_or(false), true);
pub fn set_ttl(&self, ttl: u32) -> Result<(), Error>
1.9.0[src]
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.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_ttl(100).expect("set_ttl call failed");
pub fn ttl(&self) -> Result<u32, Error>
1.9.0[src]
Gets the value of the IP_TTL
option for this socket.
For more information about this option, see set_ttl
.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.set_ttl(100).expect("set_ttl call failed"); assert_eq!(stream.ttl().unwrap_or(0), 100);
pub fn take_error(&self) -> Result<Option<Error>, Error>
1.9.0[src]
Gets 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.
Examples
use std::net::TcpStream; let stream = TcpStream::connect("127.0.0.1:8080") .expect("Couldn't connect to the server..."); stream.take_error().expect("No error was expected...");
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<(), Error>
1.9.0[src]
Moves this TCP stream into or out of nonblocking mode.
This will result in read
, write
, recv
and send
operations
becoming nonblocking, i.e., immediately returning from their calls.
If the IO operation is successful, Ok
is returned and no further
action is required. If the IO operation could not be completed and needs
to be retried, an error with kind io::ErrorKind::WouldBlock
is
returned.
On Unix platforms, calling this method corresponds to calling fcntl
FIONBIO
. On Windows calling this method corresponds to calling
ioctlsocket
FIONBIO
.
Examples
Reading bytes from a TCP stream in non-blocking mode:
use std::io::{self, Read}; use std::net::TcpStream; let mut stream = TcpStream::connect("127.0.0.1:7878") .expect("Couldn't connect to the server..."); stream.set_nonblocking(true).expect("set_nonblocking call failed"); let mut buf = vec![]; loop { match stream.read_to_end(&mut buf) { Ok(_) => break, Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => { // wait until network socket is ready, typically implemented // via platform-specific APIs such as epoll or IOCP wait_for_fd(); } Err(e) => panic!("encountered IO error: {}", e), }; }; println!("bytes: {:?}", buf);
Trait Implementations
impl Connection for TcpStreamWrapper
[src]
type Error = IOError
The error type returned by the connect
or close
functions. This is an associated type for the trait meaning each specific implementation of the Connection
trait may choose the appropriate concrete error type to return. The only constraint applied is that the selected error type must implement the Error trait from the standard library. This allows for the error to relevant to the context of the Connection
implementation while avoiding unnecessary type parameters or having to coerce data between incompatible error types. Read more
fn connect(&mut self) -> Result<(), Self::Error>
[src]
fn close(&mut self) -> Result<(), Self::Error>
[src]
fn is_valid(&mut self) -> bool
[src]
fn has_broken(&self) -> bool
[src]
impl Debug for TcpStreamWrapper
[src]
impl Deref for TcpStreamWrapper
[src]
impl DerefMut for TcpStreamWrapper
[src]
Auto Trait Implementations
impl RefUnwindSafe for TcpStreamWrapper
impl Send for TcpStreamWrapper
impl Sync for TcpStreamWrapper
impl Unpin for TcpStreamWrapper
impl UnwindSafe for TcpStreamWrapper
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SendSyncUnwindSafe for T where
T: Send + Sync + UnwindSafe + ?Sized,
T: Send + Sync + UnwindSafe + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,