Struct axum::ws::WebSocketUpgrade

pub struct WebSocketUpgrade<F, B, T> { /* fields omitted */ }

This is supported on crate feature ws only.

Service that upgrades connections to websockets and spawns a task to handle the stream.

Created with ws.

See the module docs for more details.

Implementations

impl<F, B, T> WebSocketUpgrade<F, B, T>

pub fn max_send_queue(self, max: usize) -> Self

Set the size of the internal message send queue.

pub fn max_message_size(self, max: usize) -> Self

Set the maximum message size (defaults to 64 megabytes)

pub fn max_frame_size(self, max: usize) -> Self

Set the maximum frame size (defaults to 16 megabytes)

Trait Implementations

impl<F, B, T> Clone for WebSocketUpgrade<F, B, T> where
    F: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F, B, T> Debug for WebSocketUpgrade<F, B, T>

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

Formats the value using the given formatter.

impl<ReqBody, F, T> Service<Request<ReqBody>> for WebSocketUpgrade<F, ReqBody, T> where
    F: WebSocketHandler<ReqBody, T> + Clone + Send + 'static,
    T: FromRequest<ReqBody> + Send + 'static,
    ReqBody: Send + 'static, 

type Response = Response<BoxBody>

Responses given by the service.

type Error = Infallible

Errors produced by the service.

type Future = ResponseFuture

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<ReqBody>) -> Self::Future

Process the request and return the response asynchronously.