Skip to main content

CsrfConfig

Struct CsrfConfig 

Source
pub struct CsrfConfig {
    pub cookie_name: String,
    pub header_name: String,
    pub mode: CsrfMode,
    pub rotate_token: bool,
    pub production: bool,
    pub error_message: Option<String>,
}
Expand description

Configuration for CSRF protection middleware.

Fields§

§cookie_name: String

Cookie name for CSRF token (default: “csrf_token”).

§header_name: String

Header name for CSRF token (default: “x-csrf-token”).

§mode: CsrfMode

CSRF protection mode (default: DoubleSubmit).

§rotate_token: bool

Whether to rotate token on each request (default: false).

§production: bool

Whether in production mode (affects Secure cookie flag).

§error_message: Option<String>

Custom error message for CSRF failures.

Implementations§

Source§

impl CsrfConfig

Source

pub fn new() -> Self

Creates a new configuration with defaults.

Source

pub fn cookie_name(self, name: impl Into<String>) -> Self

Sets the cookie name for CSRF token.

Source

pub fn header_name(self, name: impl Into<String>) -> Self

Sets the header name for CSRF token.

Source

pub fn mode(self, mode: CsrfMode) -> Self

Sets the CSRF protection mode.

Source

pub fn rotate_token(self, rotate: bool) -> Self

Enables token rotation on each request.

Source

pub fn production(self, production: bool) -> Self

Sets production mode (affects Secure cookie flag).

Source

pub fn error_message(self, message: impl Into<String>) -> Self

Sets a custom error message for CSRF failures.

Trait Implementations§

Source§

impl Clone for CsrfConfig

Source§

fn clone(&self) -> CsrfConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CsrfConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CsrfConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ResponseProduces<T> for T