# actix_web::http::header::DispositionParam - Rust
API documentation for the Rust `DispositionParam` enum in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, DispositionParam

# [−] [src] 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.

`FilenameExt(ExtendedValue)`

An extended file name. It must not exist for `ContentType::Formdata` according to RFC7578 Section 4.2.

`Unknown(String, String)`

An unrecognized regular parameter as defined in RFC5987 as reg-parameter, in RFC6266 as token "=" value. Recipients should ignore unrecognizable parameters.

`UnknownExt(String, ExtendedValue)`

An unrecognized extended paramater as defined in RFC5987 as ext-parameter, in RFC6266 as ext-token "=" ext-value. The single trailling asterisk is not included. Recipients should ignore unrecognizable parameters.

## Methods

###

`impl DispositionParam`

[src]

####

`pub fn is_name(&self) -> bool`

[src]

Returns `true` if the paramater is `Name`.

####

`pub fn is_filename(&self) -> bool`

[src]

Returns `true` if the paramater is `Filename`.

####

`pub fn is_filename_ext(&self) -> bool`

[src]

Returns `true` if the paramater is `FilenameExt`.

####

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

[src]

Returns `true` if the paramater is `Unknown` and the `name` matches.

####

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

[src]

Returns `true` if the paramater is `UnknownExt` and the `name` matches.

####

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

[src]

Returns the name if applicable.

####

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

[src]

Returns the filename if applicable.

####

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

[src]

Returns the filename* if applicable.

####

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

[src]

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>`

[src]

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

## Trait Implementations

###

`impl PartialEq<DispositionParam> for DispositionParam`

[src]

####

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

[src]

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

####

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

[src]

This method tests for `!=`.

###

`impl Clone for DispositionParam`

[src]

####

`fn clone(&self) -> DispositionParam`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl Display for DispositionParam`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl Debug for DispositionParam`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl Send for DispositionParam`

###

`impl Sync for DispositionParam`

## Blanket Implementations

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut T)`

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

###

`impl<T> ToString for T where T: Display + ?Sized,`

[src]

####

`fn to_string(&self) -> String`

[src]

Converts the given value to a `String`. Read more

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id`)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)