Struct lettre::message::header::ContentDisposition

pub struct ContentDisposition {
    pub disposition: DispositionType,
    pub parameters: Vec<DispositionParam>,
}

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 hyperx::header::{ContentDisposition, DispositionType, DispositionParam, Charset, TypedHeaders};

let mut headers = http::HeaderMap::new();
headers.encode(&ContentDisposition {
    disposition: DispositionType::Attachment,
    parameters: vec![DispositionParam::Filename(
      Charset::Iso_8859_1, // The character set for the bytes of the filename
      None, // The optional language tag (see `language-tag` crate)
      b"\xa9 Copyright 1989.txt".to_vec() // the actual bytes of the filename
    )]
});

Fields

disposition: DispositionType

The disposition

parameters: Vec<DispositionParam>

Disposition parameters

Trait Implementations

impl Clone for ContentDisposition

fn clone(&self) -> ContentDisposition

Returns a copy 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 Display for ContentDisposition

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

Formats the value using the given formatter.

impl Header for ContentDisposition

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header<'a, T>(raw: &'a T) -> Result<ContentDisposition, Error> where
    T: RawLike<'a>, 

Parse a header from a raw stream of bytes.

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

Format a header to outgoing stream.

impl PartialEq<ContentDisposition> for ContentDisposition

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

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

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

This method tests for !=.

impl StandardHeader for ContentDisposition

fn http_header_name() -> HeaderName

The HeaderName from the http crate for this header.