Enum actix_web::http::header::DispositionParam

pub enum DispositionParam {
    Name(String),
    Filename(String),
    FilenameExt(ExtendedValue),
    Unknown(String, String),
    UnknownExt(String, ExtendedValue),
}

Parameter in ContentDisposition.

Examples

use actix_web::http::header::DispositionParam;

let param = DispositionParam::Filename(String::from("sample.txt"));
assert!(param.is_filename());
assert_eq!(param.as_filename().unwrap(), "sample.txt");

Variants

Name(String)

For DispositionType::FormData (i.e. multipart/form-data), the name of an field from the form.

Filename(String)

A plain file name.

It is not supposed to contain any non-ASCII characters when used in a Content-Disposition HTTP response header, where FilenameExt with charset UTF-8 may be used instead in case there are Unicode characters in file names.

FilenameExt(ExtendedValue)

An extended file name. It must not exist for ContentType::Formdata according to RFC 7578 §4.2.

Unknown(String, String)

An unrecognized regular parameter as defined in RFC 5987 §3.2.1 as reg-parameter, in RFC 6266 §4.1 as token "=" value. Recipients should ignore unrecognizable parameters.

UnknownExt(String, ExtendedValue)

An unrecognized extended parameter as defined in RFC 5987 §3.2.1 as ext-parameter, in RFC 6266 §4.1 as ext-token "=" ext-value. The single trailing asterisk is not included. Recipients should ignore unrecognizable parameters.

Implementations

impl DispositionParam

pub fn is_name(&self) -> bool

Returns true if the parameter is Name.

pub fn is_filename(&self) -> bool

Returns true if the parameter is Filename.

pub fn is_filename_ext(&self) -> bool

Returns true if the parameter is FilenameExt.

pub fn is_unknown<T: AsRef<str>>(&self, name: T) -> bool

Returns true if the parameter is Unknown and the name matches.

pub fn is_unknown_ext<T: AsRef<str>>(&self, name: T) -> bool

Returns true if the parameter is UnknownExt and the name matches.

pub fn as_name(&self) -> Option<&str>

Returns the name if applicable.

pub fn as_filename(&self) -> Option<&str>

Returns the filename if applicable.

pub fn as_filename_ext(&self) -> Option<&ExtendedValue>

Returns the filename* if applicable.

pub fn as_unknown<T: AsRef<str>>(&self, name: T) -> Option<&str>

Returns the value of the unrecognized regular parameter if it is Unknown and the name matches.

pub fn as_unknown_ext<T: AsRef<str>>(&self, name: T) -> Option<&ExtendedValue>

Returns the value of the unrecognized extended parameter if it is Unknown and the name matches.

Trait Implementations

impl Clone for DispositionParam

fn clone(&self) -> DispositionParam

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DispositionParam

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

Formats the value using the given formatter.

impl Display for DispositionParam

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

Formats the value using the given formatter.

impl PartialEq for DispositionParam

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DispositionParam

impl StructuralPartialEq for DispositionParam