Struct WebSocketUpgrade 

pub struct WebSocketUpgrade { /* private fields */ }

Represents a validated WebSocket upgrade request.

This struct is returned after validating both authentication and origin, indicating that the WebSocket upgrade can proceed safely.

Example

use actix_security::http::security::websocket::{WebSocketSecurityConfig, WebSocketUpgrade};

let config = WebSocketSecurityConfig::new()
    .allowed_origins(vec!["https://myapp.com".into()])
    .require_authentication(true);

#[get("/ws")]
async fn ws_handler(
    req: HttpRequest,
    stream: web::Payload,
    config: web::Data<WebSocketSecurityConfig>,
) -> Result<HttpResponse, actix_web::Error> {
    // Validates auth and origin in one step
    let upgrade = config.validate_upgrade(&req)?;

    // Access the user
    let user = upgrade.user();

    // Proceed with upgrade
    let resp = actix_ws::start(MyActor::new(user.clone()), &req, stream)?;
    Ok(resp)
}

Implementations

impl WebSocketUpgrade

pub fn new(user: Option<User>, origin: Option<String>) -> WebSocketUpgrade

Creates a new WebSocketUpgrade.

pub fn user(&self) -> Option<&User>

Returns the authenticated user, if any.

pub fn into_user(self) -> Option<User>

Consumes self and returns the user.

pub fn origin(&self) -> Option<&str>

Returns the origin header value, if present.

pub fn is_authenticated(&self) -> bool

Returns true if the request came from an authenticated user.

pub fn username(&self) -> Option<&str>

Returns the username if authenticated.

Trait Implementations

impl Clone for WebSocketUpgrade

fn clone(&self) -> WebSocketUpgrade

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketUpgrade

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

Formats the value using the given formatter.