Struct WsByteStream 

pub struct WsByteStream { /* private fields */ }

A WebSocket presented as a raw byte duplex (AsyncRead + AsyncWrite) — item 1 in its “looks like a TCP stream” form.

A bridge runs on a spawned task pumping the WebSocket to one end of an in-memory tokio::io::duplex; this handle is the other end. That makes it usable anywhere a TCP stream is — most importantly, handed straight to an h2c server via serve_connection to run an in-process HTTP/2 service over the tunnel (item 2).

Implementations

impl WsByteStream

pub fn new<S>(ws_io: S) -> Self

where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,

Wrap an upgraded WebSocket byte stream (from accept), spawning the bridge pump onto the current tokio runtime.

pub fn with_config<S>(ws_io: S, config: BridgeConfig) -> Self

where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,

Like WsByteStream::new, but with control-frame configuration and hooks (BridgeConfig) — e.g. a control_channel to send control frames, or on_close to observe the peer’s close reason.

Trait Implementations

impl AsyncRead for WsByteStream

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 WsByteStream

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, Error>>

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.