Struct viz_core::types::WebSocket

pub struct WebSocket { /* private fields */ }

Available on crate feature websocket only.

Then WebSocket provides the API for creating and managing a WebSocket connection, as well as for sending and receiving data on the connection.

Implementations

impl WebSocket

pub fn protocols<I>(self, protocols: I) -> Self

where I: IntoIterator, I::Item: Into<Cow<'static, str>>,

The specifies one or more protocols that you wish to use.

In order of preference. The first one that is supported by the server will be selected and responsed.

pub fn on_upgrade_with_config<F, Fut>( self, callback: F, config: Option<WebSocketConfig> ) -> Response

where F: FnOnce(WebSocketStream) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Finish the upgrade, passing a function and a WebSocketConfig to handle the WebSocket.

Panics

When missing OnUpgrade

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

where F: FnOnce(WebSocketStream) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Finish the upgrade, passing a function to handle the WebSocket.

Trait Implementations

impl Debug for WebSocket

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

Formats the value using the given formatter.

impl FromRequest for WebSocket

type Error = WebSocketError

The type returned in the event of a conversion error.

async fn extract(req: &mut Request) -> Result<Self, Self::Error>

Extracts this type from the HTTP Request.

impl IntoResponse for WebSocket

fn into_response(self) -> Response

Convert self to HTTP Response.

fn into_error(self) -> Error

Convert self to the Error.