Struct rocket_csrf_guard::CsrfProtectedForm

pub struct CsrfProtectedForm<V, F>
where
    V: CsrfTokenVerifier,
{ /* private fields */ }

A wrapper form which parses the initial form, dereferences to it, and ensures CSRF checks pass

Implementations

impl<V, F> CsrfProtectedForm<V, F>

where V: CsrfTokenVerifier,

pub fn into_inner(self) -> F

impl<V, F> CsrfProtectedForm<V, Form<F>>

where V: CsrfTokenVerifier,

pub fn into_innermost(self) -> F

Extracts the inner form, throwing away the proof.

pub fn into_parts(self) -> (V::Proof, F)

Extracts the inner form and proof.

Examples found in repository

examples/end_to_end.rs (line 239)

fn do_logout(
    session: Session,
    form: SessionCsrfProtectedForm<Form<LogoutForm>>,
    manager: &State<SessionManager>,
    cookies: &CookieJar<'_>,
) -> Redirect {
    // In a real application, we'd check for passwords or something.
    let (proof, _) = form.into_parts();
    manager.logout(proof, &session.session_id_hash, cookies);
    Redirect::to(uri!(show_login_page))
}

Trait Implementations

impl<V, F> Deref for CsrfProtectedForm<V, F>

where V: CsrfTokenVerifier,

type Target = F

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<V, F> DerefMut for CsrfProtectedForm<V, F>

where V: CsrfTokenVerifier,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'r, V, F> FromData<'r> for CsrfProtectedForm<V, F>

where V: CsrfTokenVerifier + FromRequest<'r> + Send + Sync, V::Proof: Clone, F: WithUserProvidedCsrfToken + FromData<'r> + Sized + Send + Sync,

type Error = CsrfProtectedFormError<<F as FromData<'r>>::Error>

The associated error to be returned when the guard fails.

fn from_data<'life0, 'async_trait>( request: &'r Request<'life0>, data: Data<'r> ) -> Pin<Box<dyn Future<Output = Outcome<'r, Self>> + Send + 'async_trait>>

where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Asynchronously validates, parses, and converts an instance of Self from the incoming request body data.