# content_disposition.rs.html -- source
Source to the Rust file `src/header/common/content_disposition.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285

    // # References
    //
    // "The Content-Disposition Header Field" https://www.ietf.org/rfc/rfc2183.txt
    // "The Content-Disposition Header Field in the Hypertext Transfer Protocol (HTTP)" https://www.ietf.org/rfc/rfc6266.txt
    // "Returning Values from Forms: multipart/form-data" https://www.ietf.org/rfc/rfc2388.txt
    // Browser conformance tests at: http://greenbytes.de/tech/tc2231/
    // IANA assignment: http://www.iana.org/assignments/cont-disp/cont-disp.xhtml

    use language_tags::LanguageTag;
    use header;
    use header::{Header, IntoHeaderValue, Writer};
    use header::shared::Charset;

    use std::fmt::{self, Write};

    /// The implied disposition of the content of the HTTP body.
    #[derive(Clone, Debug, PartialEq)]
    pub enum DispositionType {
        /// Inline implies default processing
        Inline,
        /// Attachment implies that the recipient should prompt the user to save the response locally,
        /// rather than process it normally (as per its media type).
        Attachment,
        /// Extension type.  Should be handled by recipients the same way as Attachment
        Ext(String)
    }

    /// A parameter to the disposition type.
    #[derive(Clone, Debug, PartialEq)]
    pub enum DispositionParam {
        /// A Filename consisting of a Charset, an optional LanguageTag, and finally a sequence of
        /// bytes representing the filename
        Filename(Charset, Option<LanguageTag>, Vec<u8>),
        /// Extension type consisting of token and value.  Recipients should ignore unrecognized
        /// parameters.
        Ext(String, String)
    }

    /// A `Content-Disposition` header, (re)defined in [RFC6266](https://tools.ietf.org/html/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

    /// ```text
    /// 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 actix_web::http::header::{ContentDisposition, DispositionType, DispositionParam, Charset};
    ///
    /// let cd1 = 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
    ///     )]
    /// };
    ///
    /// let cd2 = ContentDisposition {
    ///     disposition: DispositionType::Inline,
    ///     parameters: vec![DispositionParam::Filename(
    ///       Charset::Ext("UTF-8".to_owned()),
    ///       None,
    ///       "\u{2764}".as_bytes().to_vec()
    ///     )]
    /// };
    /// ```
    #[derive(Clone, Debug, PartialEq)]
    pub struct ContentDisposition {
        /// The disposition
        pub disposition: DispositionType,
        /// Disposition parameters
        pub parameters: Vec<DispositionParam>,
    }
    impl ContentDisposition {
        /// Parse a raw Content-Disposition header value
        pub fn from_raw(hv: &header::HeaderValue) -> Result<Self, ::error::ParseError> {
            header::from_one_raw_str(Some(hv)).and_then(|s: String| {
                let mut sections = s.split(';');
                let disposition = match sections.next() {
                    Some(s) => s.trim(),
                    None => return Err(::error::ParseError::Header),
                };

                let mut cd = ContentDisposition {
                    disposition: if disposition.eq_ignore_ascii_case("inline") {
                        DispositionType::Inline
                    } else if disposition.eq_ignore_ascii_case("attachment") {
                        DispositionType::Attachment
                    } else {
                        DispositionType::Ext(disposition.to_owned())
                    },
                    parameters: Vec::new(),
                };

                for section in sections {
                    let mut parts = section.splitn(2, '=');

                    let key = if let Some(key) = parts.next() {
                        key.trim()
                    } else {
                        return Err(::error::ParseError::Header);
                    };

                    let val = if let Some(val) = parts.next() {
                        val.trim()
                    } else {
                        return Err(::error::ParseError::Header);
                    };

                    cd.parameters.push(
                        if key.eq_ignore_ascii_case("filename") {
                            DispositionParam::Filename(
                                Charset::Ext("UTF-8".to_owned()), None,
                                val.trim_matches('"').as_bytes().to_owned())
                        } else if key.eq_ignore_ascii_case("filename*") {
                            let extended_value = try!(header::parse_extended_value(val));
                            DispositionParam::Filename(extended_value.charset, extended_value.language_tag, extended_value.value)
                        } else {
                            DispositionParam::Ext(key.to_owned(), val.trim_matches('"').to_owned())
                        }
                    );
                }

                Ok(cd)
            })
        }
    }

    impl IntoHeaderValue for ContentDisposition {
        type Error = header::InvalidHeaderValueBytes;

        fn try_into(self) -> Result<header::HeaderValue, Self::Error> {
            let mut writer = Writer::new();
            let _ = write!(&mut writer, "{}", self);
            header::HeaderValue::from_shared(writer.take())
        }
    }

    impl Header for ContentDisposition {
        fn name() -> header::HeaderName {
            header::CONTENT_DISPOSITION
        }

        fn parse<T: ::HttpMessage>(msg: &T) -> Result<Self, ::error::ParseError> {
            if let Some(h) = msg.headers().get(Self::name()) {
                Self::from_raw(&h)
            } else {
                Err(::error::ParseError::Header)
            }
        }
    }

    impl fmt::Display for ContentDisposition {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            match self.disposition {
                DispositionType::Inline => try!(write!(f, "inline")),
                DispositionType::Attachment => try!(write!(f, "attachment")),
                DispositionType::Ext(ref s) => try!(write!(f, "{}", s)),
            }
            for param in &self.parameters {
                match *param {
                    DispositionParam::Filename(ref charset, ref opt_lang, ref bytes) => {
                        let mut use_simple_format: bool = false;
                        if opt_lang.is_none() {
                            if let Charset::Ext(ref ext) = *charset {
                                if ext.eq_ignore_ascii_case("utf-8") {
                                    use_simple_format = true;
                                }
                            }
                        }
                        if use_simple_format {
                            use std::str;
                            try!(write!(f, "; filename=\"{}\"",
                                        match str::from_utf8(bytes) {
                                            Ok(s) => s,
                                            Err(_) => return Err(fmt::Error),
                                        }));
                        } else {
                            try!(write!(f, "; filename*={}'", charset));
                            if let Some(ref lang) = *opt_lang {
                                try!(write!(f, "{}", lang));
                            };
                            try!(write!(f, "'"));
                            try!(header::http_percent_encode(f, bytes))
                        }
                    },
                    DispositionParam::Ext(ref k, ref v) => try!(write!(f, "; {}=\"{}\"", k, v)),
                }
            }
            Ok(())
        }
    }

    #[cfg(test)]
    mod tests {
        use super::{ContentDisposition,DispositionType,DispositionParam};
        use header::HeaderValue;
        use header::shared::Charset;
        #[test]
        fn test_from_raw() {
            assert!(ContentDisposition::from_raw(&HeaderValue::from_static("")).is_err());

            let a = HeaderValue::from_static("form-data; dummy=3; name=upload; filename=\"sample.png\"");
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Ext("form-data".to_owned()),
                parameters: vec![
                    DispositionParam::Ext("dummy".to_owned(), "3".to_owned()),
                    DispositionParam::Ext("name".to_owned(), "upload".to_owned()),
                    DispositionParam::Filename(
                        Charset::Ext("UTF-8".to_owned()),
                        None,
                        "sample.png".bytes().collect()) ]
            };
            assert_eq!(a, b);

            let a = HeaderValue::from_static("attachment; filename=\"image.jpg\"");
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Attachment,
                parameters: vec![
                    DispositionParam::Filename(
                        Charset::Ext("UTF-8".to_owned()),
                        None,
                        "image.jpg".bytes().collect()) ]
            };
            assert_eq!(a, b);

            let a = HeaderValue::from_static("attachment; filename*=UTF-8''%c2%a3%20and%20%e2%82%ac%20rates");
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Attachment,
                parameters: vec![
                    DispositionParam::Filename(
                        Charset::Ext("UTF-8".to_owned()),
                        None,
                        vec![0xc2, 0xa3, 0x20, b'a', b'n', b'd', 0x20,
                             0xe2, 0x82, 0xac, 0x20, b'r', b'a', b't', b'e', b's']) ]
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_display() {
            let as_string = "attachment; filename*=UTF-8'en'%C2%A3%20and%20%E2%82%AC%20rates";
            let a = HeaderValue::from_static(as_string);
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let display_rendered = format!("{}",a);
            assert_eq!(as_string, display_rendered);

            let a = HeaderValue::from_static("attachment; filename*=UTF-8''black%20and%20white.csv");
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let display_rendered = format!("{}",a);
            assert_eq!("attachment; filename=\"black and white.csv\"".to_owned(), display_rendered);

            let a = HeaderValue::from_static("attachment; filename=colourful.csv");
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let display_rendered = format!("{}",a);
            assert_eq!("attachment; filename=\"colourful.csv\"".to_owned(), display_rendered);
        }
    }

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