Struct ContentDisposition 

pub struct ContentDisposition(/* private fields */);

Available on crate features http and std only.

A Content-Disposition header, (re)defined in RFC6266.

The Content-Disposition response header field is used to convey additional information about how to process the response payload, and also can be used to attach additional metadata, such as the filename to use when saving the response payload locally.

ABNF

content-disposition = "Content-Disposition" ":"
                      disposition-type *( ";" disposition-parm )

disposition-type    = "inline" | "attachment" | disp-ext-type
                      ; case-insensitive

disp-ext-type       = token

disposition-parm    = filename-parm | disp-ext-parm

filename-parm       = "filename" "=" value
                    | "filename*" "=" ext-value

disp-ext-parm       = token "=" value
                    | ext-token "=" ext-value

ext-token           = <the characters in token, followed by "*">

Example

use rama_http_headers::ContentDisposition;

let cd = ContentDisposition::inline();

Implementations

impl ContentDisposition

pub fn inline() -> ContentDisposition

Construct a Content-Disposition: inline header.

pub fn attachment(filename: &str) -> ContentDisposition

Construct a Content-Disposition: attachment header with a filename.

The filename is encoded as a quoted string. Non-ASCII filenames also get an RFC 8187 filename* parameter. If the filename contains control characters this falls back to a plain attachment header.

pub fn try_attachment( filename: &str, ) -> Result<ContentDisposition, InvalidContentDispositionFilename>

Construct an attachment header, rejecting filenames with control characters.

pub fn is_inline(&self) -> bool

Check if the disposition-type is inline.

pub fn is_attachment(&self) -> bool

Check if the disposition-type is attachment.

pub fn is_form_data(&self) -> bool

Check if the disposition-type is form-data.

Trait Implementations

impl Clone for ContentDisposition

fn clone(&self) -> ContentDisposition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentDisposition

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

Formats the value using the given formatter.

impl HeaderDecode for ContentDisposition

fn decode<'i, I>(values: &mut I) -> Result<ContentDisposition, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for ContentDisposition

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl TypedHeader for ContentDisposition

fn name() -> &'static HeaderName

The name of this header.