Struct WebSocketUpgrade

pub struct WebSocketUpgrade<S, R, C = JsonCodec> { /* private fields */ }

A version of axum::extract::ws::WebSocketUpgrade with type safe messages.

Type parameters

• S - The message sent from the server to the client.
• R - The message sent from the client to the server.
• C - The Codec used to encode and decode messages. Defaults to JsonCodec which serializes messages with serde_json.

Implementations

impl<S, R, C> WebSocketUpgrade<S, R, C>

pub fn on_upgrade<F, Fut>(self, callback: F) -> impl IntoResponse

where F: FnOnce(WebSocket<S, R, C>) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static, S: Send, R: Send,

Finalize upgrading the connection and call the provided callback with the stream.

This is analagous to axum::extract::ws::WebSocketUpgrade::on_upgrade.

pub fn map<F>(self, f: F) -> Self

where F: FnOnce(WebSocketUpgrade) -> WebSocketUpgrade,

Apply a transformation to the inner axum::extract::ws::WebSocketUpgrade.

This can be used to apply configuration.

pub fn into_inner(self) -> WebSocketUpgrade

Get the inner axum axum::extract::ws::WebSocketUpgrade.

Trait Implementations

impl<S, R, C> Debug for WebSocketUpgrade<S, R, C>

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

Formats the value using the given formatter.

impl<S, R, C, B> FromRequestParts<B> for WebSocketUpgrade<S, R, C>

where B: Send + Sync,

type Rejection = <WebSocketUpgrade as FromRequestParts<B>>::Rejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, state: &'life1 B, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

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

Perform the extraction.