Struct Stream 

pub struct Stream {
    pub established_ts: SystemTime,
    pub tracer: Option<Tracer>,
    pub rx_ts: Option<SystemTime>,
    /* private fields */
}

A concrete type for transport layer connection + extra fields for logging

Fields

established_ts: SystemTime

When this connection is established

tracer: Option<Tracer>

The distributed tracing object for this stream

rx_ts: Option<SystemTime>

Last rx timestamp associated with the last recvmsg call.

Implementations

impl Stream

pub fn set_nodelay(&mut self) -> Result<()>

set TCP nodelay for this connection if self is TCP

pub fn set_keepalive(&mut self, ka: &TcpKeepalive) -> Result<()>

set TCP keepalive settings for this connection if self is TCP

pub fn set_rx_timestamp(&mut self) -> Result<()>

Available on Linux only.

pub fn rewind(&mut self, data: &[u8])

Put some data back to the head of the stream to be read again.

This is useful when you’ve read data to detect a protocol (e.g., PROXY protocol) but the data wasn’t what you expected, so you need to “unread” it.

Trait Implementations

impl AsRawFd for Stream

Available on Unix only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for Stream

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for Stream

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for Stream

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

Formats the value using the given formatter.

impl Drop for Stream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<TcpStream> for Stream

fn from(s: TcpStream) -> Self

Converts to this type from the input type.

impl From<UnixStream> for Stream

Available on Unix only.

fn from(s: UnixStream) -> Self

Converts to this type from the input type.

impl From<VirtualSocketStream> for Stream

fn from(s: VirtualSocketStream) -> Self

Converts to this type from the input type.

impl GetProxyDigest for Stream

fn get_proxy_digest(&self) -> Option<Arc<ProxyDigest>>

fn set_proxy_digest(&mut self, digest: ProxyDigest)

impl GetSocketDigest for Stream

fn get_socket_digest(&self) -> Option<Arc<SocketDigest>>

fn set_socket_digest(&mut self, socket_digest: SocketDigest)

impl GetTimingDigest for Stream

fn get_timing_digest(&self) -> Vec<Option<TimingDigest>>

Return the timing for each layer from the lowest layer to upper

fn get_read_pending_time(&self) -> Duration

fn get_write_pending_time(&self) -> Duration

impl Peek for Stream

fn try_peek<'life0, 'life1, 'async_trait>( &'life0 mut self, buf: &'life1 mut [u8], ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Peek data but not consuming it. This call should block until some data is sent. Return false if peeking is not supported/allowed.

impl Shutdown for Stream

fn shutdown<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl Ssl for Stream

fn get_ssl(&self) -> Option<&TlsRef>

Return the TLS info if the connection is over TLS

fn get_ssl_digest(&self) -> Option<Arc<SslDigest>>

Return the tls::SslDigest for logging

fn selected_alpn_proto(&self) -> Option<ALPN>

Return selected ALPN if any

impl UniqueID for Stream

Available on Unix only.

fn id(&self) -> UniqueIDType

The ID returned should be unique among all existing connections of the same type. But ID can be recycled after a connection is shutdown.