Struct CsrfToken 

pub struct CsrfToken(pub String);

Extractor for the current CSRF token.

• On safe requests (GET/HEAD), ensures a token exists and makes it available to handlers.
• On mutating requests (POST/PUT/PATCH/DELETE), extracting CsrfToken verifies the token before your handler is called; if verification fails, the request is rejected and your handler is not executed.

Examples

Read the token in a form-rendering handler and embed it into HTML or a JSON response.

use actix_csrf_middleware::CsrfToken;
use actix_web::{HttpResponse, Responder};

async fn form(csrf: CsrfToken) -> impl Responder {
    HttpResponse::Ok().body(format!("token:{}", csrf.0))
}

Note: Using this extractor requires the middleware to be installed via CsrfMiddleware::new. If not configured, extraction will fail with an internal error.

Tuple Fields

0: String

Trait Implementations

impl Clone for CsrfToken

fn clone(&self) -> CsrfToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FromRequest for CsrfToken

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<CsrfToken, <CsrfToken as FromRequest>::Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.