Struct AxumWS

pub struct AxumWS {
    inner: WebSocketStream<TokioIo<Upgraded>>,
    protocol: Option<HeaderValue>,
}

Available on crate feature ssr only.

A stream of WebSocket messages.

See the module level documentation for more details.

Fields

inner: WebSocketStream<TokioIo<Upgraded>>

protocol: Option<HeaderValue>

Implementations

impl WebSocket

pub async fn recv(&mut self) -> Option<Result<Message, Error>>

Receive another message.

Returns None if the stream has closed.

pub async fn send(&mut self, msg: Message) -> Result<(), Error>

Send a message.

pub fn protocol(&self) -> Option<&HeaderValue>

Return the selected WebSocket subprotocol, if one has been chosen.

Trait Implementations

impl Debug for WebSocket

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

Formats the value using the given formatter.

impl Sink<Message> for WebSocket

type Error = Error

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

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

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut WebSocket>, item: Message, ) -> Result<(), <WebSocket 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 WebSocket>, cx: &mut Context<'_>, ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

Flush any remaining output from this sink.

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

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

impl Stream for WebSocket

type Item = Result<Message, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut WebSocket>, cx: &mut Context<'_>, ) -> Poll<Option<<WebSocket 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.