Struct ratchet_rs::WebSocketUpgrader

pub struct WebSocketUpgrader<S, E> { /* private fields */ }

Represents a client connection that has been accepted and the upgrade request validated. This may be used to validate the request by a user and opt to either continue the upgrade or reject the connection - such as if the target path does not exist.

Implementations

impl<S, E> WebSocketUpgrader<S, E>

where S: WebSocketStream, E: Extension,

pub fn subprotocol(&self) -> Option<&String>

The subprotocol that the client has requested.

pub fn uri(&self) -> &Uri

The URI that the client has requested.

pub fn request(&self) -> &Request<()>

The original request that the client sent.

pub async fn upgrade(self) -> Result<UpgradedServer<S, E>, Error>

Attempt to upgrade this to a fully negotiated WebSocket connection.

Errors

Errors if there is an IO error.

pub async fn upgrade_with( self, headers: HeaderMap ) -> Result<UpgradedServer<S, E>, Error>

Insert headers into the response and attempt to upgrade this to a fully negotiated WebSocket connection.

Errors

Errors if there is an IO error.

pub async fn reject(self, response: WebSocketResponse) -> Result<(), Error>

Reject this connection with the response provided.

Errors

Errors if there is an IO error.

Trait Implementations

impl<S, E> Debug for WebSocketUpgrader<S, E>

where S: Debug, E: Debug,

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

Formats the value using the given formatter.