Struct HARWebSocket 

pub struct HARWebSocket<S> { /* private fields */ }

Available on crate features http and std and ws only.

HAR-capturing middleware around a WebSocket message stream.

The wrapper observes complete text and binary messages after the underlying WebSocket protocol accepts or produces them. It awaits the configured recorder before accepting the next socket operation, which applies bounded backpressure without adding capture concerns to the underlying WebSocket.

This type intentionally does not dereference to S, because directly polling the inner transport would bypass capture. Use Self::get_ref or Self::get_mut only when that bypass is explicitly intended, and call Self::into_inner to remove the middleware.

Implementations

impl<S> HARWebSocket<S>

pub fn new( inner: S, role: Role, capture: Option<WebSocketCapture>, ) -> HARWebSocket<S>

Wrap a WebSocket with an optional opaque capture handle.

pub fn from_extensions(inner: S, role: Role) -> HARWebSocket<S>

where S: ExtensionsRef,

Wrap a WebSocket using the capture handle reachable from its extensions.

pub fn into_inner(self) -> S

Remove this middleware and return the underlying WebSocket.

pub fn get_ref(&self) -> &S

Return a shared reference to the underlying WebSocket.

pub fn get_mut(&mut self) -> &mut S

Return a mutable reference to the underlying WebSocket.

impl<S> HARWebSocket<S>

where S: Sink<Message, Error = ProtocolError> + Stream<Item = Result<Message, ProtocolError>> + Unpin,

pub async fn send_message( &mut self, message: Message, ) -> Result<(), ProtocolError>

Write and flush one message.

pub async fn recv_message(&mut self) -> Result<Message, ProtocolError>

Receive one complete message.

pub async fn close( &mut self, message: Option<CloseFrame>, ) -> Result<(), ProtocolError>

Close the WebSocket.

Trait Implementations

impl<S> Debug for HARWebSocket<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> ExtensionsRef for HARWebSocket<S>

where S: ExtensionsRef,

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl<S> Sink<Message> for HARWebSocket<S>

where S: Sink<Message, Error = ProtocolError> + Unpin,

type Error = ProtocolError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut HARWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), <HARWebSocket<S> as Sink<Message>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut HARWebSocket<S>>, item: Message, ) -> Result<(), <HARWebSocket<S> as Sink<Message>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut HARWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), <HARWebSocket<S> as Sink<Message>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut HARWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), <HARWebSocket<S> as Sink<Message>>::Error>>

Flush any remaining output and close this sink, if necessary.

impl<S> Stream for HARWebSocket<S>

where S: Stream<Item = Result<Message, ProtocolError>> + Unpin,

type Item = Result<Message, ProtocolError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut HARWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Option<<HARWebSocket<S> as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.