Struct TokenField 

pub struct TokenField { /* private fields */ }

The anti-forgery token field to capture from a multipart body.

Examples

use form_net::{TokenField, TokenPlacement};

let strict = TokenField::new("csrf_token");
assert_eq!(strict.placement(), TokenPlacement::BeforeFirstFile);
assert_eq!(strict.anywhere().placement(), TokenPlacement::Anywhere);

Implementations

impl TokenField

pub const fn new(name: &'static str) -> TokenField

A token field named name that must come before the first file.

Examples

use form_net::{TokenField, TokenPlacement};

const TOKEN: TokenField = TokenField::new("csrf_token");
assert_eq!(TOKEN.name(), "csrf_token");
assert_eq!(TOKEN.placement(), TokenPlacement::BeforeFirstFile);

pub const fn anywhere(self) -> TokenField

The same field, allowed anywhere in the body.

Examples

use form_net::{Limits, Policy, TokenField};

let relaxed = Policy::DEFAULT.with_token_field(TokenField::new("csrf").anywhere());
let body = b"--X\r\nContent-Disposition: form-data; name=f; filename=a.txt\r\n\r\nhi\r\n\
             --X\r\nContent-Disposition: form-data; name=csrf\r\n\r\nt0k\r\n--X--";
let form = form_net::parse_multipart_with(CT, body, &Limits::DEFAULT, &relaxed)?;
assert_eq!(form.field("csrf"), Some("t0k"));

pub const fn name(&self) -> &'static str

The field name, matched byte for byte.

Examples

let field = form_net::TokenField::new("csrf").anywhere();
assert_eq!(field.name(), "csrf");

pub const fn placement(&self) -> TokenPlacement

Where the field must be.

Examples

use form_net::{TokenField, TokenPlacement};

assert_eq!(TokenField::new("t").placement(), TokenPlacement::BeforeFirstFile);
assert_eq!(TokenField::new("t").anywhere().placement(), TokenPlacement::Anywhere);

Trait Implementations

impl Clone for TokenField

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TokenField

impl Debug for TokenField

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

Formats the value using the given formatter.

impl Eq for TokenField

impl PartialEq for TokenField

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TokenField