Struct axum_csrf::CsrfToken

pub struct CsrfToken {
    pub(crate) token: String,
    pub(crate) config: CsrfConfig,
}

This is the Token that is generated when a user is routed to a page. If a Cookie exists then it will be used as the Token. Otherwise a new one is made.

Fields

token: String

config: CsrfConfig

Implementations

impl CsrfToken

pub fn authenticity_token(&self) -> Result<String, CsrfError>

Used to get the hashed Token to place within the form.

pub fn verify(&self, form_authenticity_token: &str) -> Result<(), CsrfError>

Verifies that the form returned Token and the cookie tokens match.

Trait Implementations

impl Clone for CsrfToken

fn clone(&self) -> CsrfToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> FromRequestParts<S> for CsrfTokenwhere S: Send + Sync,

type Rejection = (StatusCode, &'static str)

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, _state: &'life1 S ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the extraction.

impl IntoResponse for CsrfToken

fn into_response(self) -> Response

Create a response.

impl IntoResponseParts for CsrfToken

type Error = Infallible

The type returned in the event of an error.

fn into_response_parts( self, res: ResponseParts ) -> Result<ResponseParts, Self::Error>

Set parts of the response