Struct Policy 

#[non_exhaustive]
pub struct Policy {
    pub percent: PercentPolicy,
    pub extended_filename: ExtendedFilenamePolicy,
    pub unknown_headers: HeaderPolicy,
    pub empty_files: EmptyFilePolicy,
    pub token_field: Option<TokenField>,
}

The behaviours a route may choose. The defaults are the strict ones; every alternative is named after what it allows.

Examples

use form_net::{EmptyFilePolicy, HeaderPolicy, Policy, TokenField};

const UPLOADS: Policy = Policy::DEFAULT
    .with_token_field(TokenField::new("csrf_token"))
    .with_empty_files(EmptyFilePolicy::Skip)
    .with_unknown_headers(HeaderPolicy::Refuse);
assert_eq!(UPLOADS.token_field.map(|t| t.name()), Some("csrf_token"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

percent: PercentPolicy

A malformed % in urlencoded input. Default Refuse.

extended_filename: ExtendedFilenamePolicy

filename* in a part. Default Refuse.

unknown_headers: HeaderPolicy

Part headers other than the three known ones. Default Ignore.

empty_files: EmptyFilePolicy

A file input left empty. Default Report.

token_field: Option<TokenField>

The anti-forgery token field to capture. Default none.

Implementations

impl Policy

pub const DEFAULT: Policy

The strict defaults.

pub const fn with_percent(self, policy: PercentPolicy) -> Self

Sets percent.

pub const fn with_extended_filename( self, policy: ExtendedFilenamePolicy, ) -> Self

Sets extended_filename.

pub const fn with_unknown_headers(self, policy: HeaderPolicy) -> Self

Sets unknown_headers.

pub const fn with_empty_files(self, policy: EmptyFilePolicy) -> Self

Sets empty_files.

pub const fn with_token_field(self, field: TokenField) -> Self

Sets the token field to capture.

Trait Implementations

impl Clone for Policy

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 Policy

impl Debug for Policy

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

Formats the value using the given formatter.

impl Default for Policy

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Policy

impl PartialEq for Policy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Policy