Struct CsrfTokenNames 

pub struct CsrfTokenNames { /* private fields */ }

Cookie and header names used by the double-submit token check.

Services that share a browser origin should configure service-specific names during startup to avoid cookie/header collisions. Store this value in the product’s startup state, app data, or a process-wide OnceLock; do not switch names while a process is serving traffic because active browser sessions would still hold the previous cookie name and frontend code may still send the previous header.

Implementations

impl CsrfTokenNames

pub fn new( cookie_name: impl Into<String>, header_name: impl AsRef<str>, ) -> Result<Self>

Builds CSRF token names after validating the cookie and header names.

Cookie names are validated against the conservative RFC 6265 token character set. Header names are parsed through Actix’s HTTP header type and are stored in canonical lower-case form, which makes comparisons and CORS allow-list generation stable.

pub fn cookie_name(&self) -> &str

Returns the configured CSRF cookie name.

pub fn header_name(&self) -> &HeaderName

Returns the configured CSRF request header name.

pub fn header_name_str(&self) -> &str

Returns the configured CSRF request header name as a lower-case string.

This is useful when building Access-Control-Allow-Headers values for browser preflight responses.

Trait Implementations

impl Clone for CsrfTokenNames

fn clone(&self) -> CsrfTokenNames

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsrfTokenNames

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

Formats the value using the given formatter.

impl Default for CsrfTokenNames

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CsrfTokenNames

fn eq(&self, other: &CsrfTokenNames) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CsrfTokenNames

impl StructuralPartialEq for CsrfTokenNames