Struct Csrf 

pub struct Csrf { /* private fields */ }

Session double-submit CSRF plugin.

Implementations

impl Csrf

pub fn new() -> Self

pub fn session_key(self, key: impl Into<String>) -> Self

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

Form / JSON field name (default csrf).

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

Primary request header name (default x-csrf-token).

pub fn auto(self, on: bool) -> Self

Disable automatic checks; use CsrfExt::verify_csrf in handlers.

pub fn skip(self, path: impl Into<String>) -> Self

Skip auto-check for a path (/hook exact, or /api/* prefix).

pub fn except(self, path: impl Into<String>) -> Self

Laravel-style alias for Self::skip.

pub fn only(self, path: impl Into<String>) -> Self

Only auto-check these paths (exact or prefix*). Empty = all paths (minus except).

pub fn methods(self, methods: impl IntoIterator<Item = Method>) -> Self

Restrict which HTTP methods require a token.

Default (empty set): all methods except GET, HEAD, OPTIONS, TRACE.

pub fn xsrf_cookie(self, on: bool) -> Self

Set readable XSRF-TOKEN cookie on responses (default: true).

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

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

Alternate header read from the XSRF cookie (default x-xsrf-token).

Trait Implementations

impl Clone for Csrf

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Csrf

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for Csrf

fn id(&self) -> &'static str

Stable plugin identifier used for dependency checks and crate::App::has_plugin.

fn requires(&self) -> &'static [&'static str]

Required plugin ids that must be installed beforehand.

fn meta(&self) -> PluginMeta

Display name, description, and declared PluginMeta::sdk version.

fn install(self, app: &mut App)

Register middleware, state, routes, and hooks on app.