      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
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    809
    810
    811
    812
    813
    814
    815
    816
    817
    818
    819
    820
    821
    822
    823
    824
    825
    826
    827
    828
    829
    830
    831
    832
    833
    834
    835
    836
    837
    838
    839
    840
    841
    842
    843
    844
    845
    846
    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    884
    885
    886
    887
    888
    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914

    // # 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/rfc7578.txt
    // Browser conformance tests at: http://greenbytes.de/tech/tc2231/
    // IANA assignment: http://www.iana.org/assignments/cont-disp/cont-disp.xhtml

    use header;
    use header::ExtendedValue;
    use header::{Header, IntoHeaderValue, Writer};
    use regex::Regex;

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

    /// Split at the index of the first `needle` if it exists or at the end.
    fn split_once(haystack: &str, needle: char) -> (&str, &str) {
        haystack.find(needle).map_or_else(
            || (haystack, ""),
            |sc| {
                let (first, last) = haystack.split_at(sc);
                (first, last.split_at(1).1)
            },
        )
    }

    /// Split at the index of the first `needle` if it exists or at the end, trim the right of the
    /// first part and the left of the last part.
    fn split_once_and_trim(haystack: &str, needle: char) -> (&str, &str) {
        let (first, last) = split_once(haystack, needle);
        (first.trim_right(), last.trim_left())
    }

    /// 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,
        /// Used in *multipart/form-data* as defined in
        /// [RFC7578](https://tools.ietf.org/html/rfc7578) to carry the field name and the file name.
        FormData,
        /// Extension type. Should be handled by recipients the same way as Attachment
        Ext(String),
    }

    impl<'a> From<&'a str> for DispositionType {
        fn from(origin: &'a str) -> DispositionType {
            if origin.eq_ignore_ascii_case("inline") {
                DispositionType::Inline
            } else if origin.eq_ignore_ascii_case("attachment") {
                DispositionType::Attachment
            } else if origin.eq_ignore_ascii_case("form-data") {
                DispositionType::FormData
            } else {
                DispositionType::Ext(origin.to_owned())
            }
        }
    }

    /// 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");
    /// ```
    #[derive(Clone, Debug, PartialEq)]
    pub enum DispositionParam {
        /// For [`DispositionType::FormData`] (i.e. *multipart/form-data*), the name of an field from
        /// the form.
        Name(String),
        /// A plain file name.
        Filename(String),
        /// An extended file name. It must not exist for `ContentType::Formdata` according to
        /// [RFC7578 Section 4.2](https://tools.ietf.org/html/rfc7578#section-4.2).
        FilenameExt(ExtendedValue),
        /// An unrecognized regular parameter as defined in
        /// [RFC5987](https://tools.ietf.org/html/rfc5987) as *reg-parameter*, in
        /// [RFC6266](https://tools.ietf.org/html/rfc6266) as *token "=" value*. Recipients should
        /// ignore unrecognizable parameters.
        Unknown(String, String),
        /// An unrecognized extended paramater as defined in
        /// [RFC5987](https://tools.ietf.org/html/rfc5987) as *ext-parameter*, in
        /// [RFC6266](https://tools.ietf.org/html/rfc6266) as *ext-token "=" ext-value*. The single
        /// trailling asterisk is not included. Recipients should ignore unrecognizable parameters.
        UnknownExt(String, ExtendedValue),
    }

    impl DispositionParam {
        /// Returns `true` if the paramater is [`Name`](DispositionParam::Name).
        #[inline]
        pub fn is_name(&self) -> bool {
            self.as_name().is_some()
        }

        /// Returns `true` if the paramater is [`Filename`](DispositionParam::Filename).
        #[inline]
        pub fn is_filename(&self) -> bool {
            self.as_filename().is_some()
        }

        /// Returns `true` if the paramater is [`FilenameExt`](DispositionParam::FilenameExt).
        #[inline]
        pub fn is_filename_ext(&self) -> bool {
            self.as_filename_ext().is_some()
        }

        /// Returns `true` if the paramater is [`Unknown`](DispositionParam::Unknown) and the `name`
        #[inline]
        /// matches.
        pub fn is_unknown<T: AsRef<str>>(&self, name: T) -> bool {
            self.as_unknown(name).is_some()
        }

        /// Returns `true` if the paramater is [`UnknownExt`](DispositionParam::UnknownExt) and the
        /// `name` matches.
        #[inline]
        pub fn is_unknown_ext<T: AsRef<str>>(&self, name: T) -> bool {
            self.as_unknown_ext(name).is_some()
        }

        /// Returns the name if applicable.
        #[inline]
        pub fn as_name(&self) -> Option<&str> {
            match self {
                DispositionParam::Name(ref name) => Some(name.as_str()),
                _ => None,
            }
        }

        /// Returns the filename if applicable.
        #[inline]
        pub fn as_filename(&self) -> Option<&str> {
            match self {
                DispositionParam::Filename(ref filename) => Some(filename.as_str()),
                _ => None,
            }
        }

        /// Returns the filename* if applicable.
        #[inline]
        pub fn as_filename_ext(&self) -> Option<&ExtendedValue> {
            match self {
                DispositionParam::FilenameExt(ref value) => Some(value),
                _ => None,
            }
        }

        /// Returns the value of the unrecognized regular parameter if it is
        /// [`Unknown`](DispositionParam::Unknown) and the `name` matches.
        #[inline]
        pub fn as_unknown<T: AsRef<str>>(&self, name: T) -> Option<&str> {
            match self {
                DispositionParam::Unknown(ref ext_name, ref value)
                    if ext_name.eq_ignore_ascii_case(name.as_ref()) =>
                {
                    Some(value.as_str())
                }
                _ => None,
            }
        }

        /// Returns the value of the unrecognized extended parameter if it is
        /// [`Unknown`](DispositionParam::Unknown) and the `name` matches.
        #[inline]
        pub fn as_unknown_ext<T: AsRef<str>>(&self, name: T) -> Option<&ExtendedValue> {
            match self {
                DispositionParam::UnknownExt(ref ext_name, ref value)
                    if ext_name.eq_ignore_ascii_case(name.as_ref()) =>
                {
                    Some(value)
                }
                _ => None,
            }
        }
    }

    /// A *Content-Disposition* header. It is compatible to be used either as
    /// [a response header for the main body](https://mdn.io/Content-Disposition#As_a_response_header_for_the_main_body)
    /// as (re)defined in [RFC6266](https://tools.ietf.org/html/rfc6266), or as
    /// [a header for a multipart body](https://mdn.io/Content-Disposition#As_a_header_for_a_multipart_body)
    /// as (re)defined in [RFC7587](https://tools.ietf.org/html/rfc7578).
    ///
    /// In a regular HTTP response, the *Content-Disposition* response header is a header indicating if
    /// the content is expected to be displayed *inline* in the browser, that is, as a Web page or as
    /// part of a Web page, or as an attachment, that is downloaded and saved locally, and also can be
    /// used to attach additional metadata, such as the filename to use when saving the response payload
    /// locally.
    ///
    /// In a *multipart/form-data* body, the HTTP *Content-Disposition* general header is a header that
    /// can be used on the subpart of a multipart body to give information about the field it applies to.
    /// The subpart is delimited by the boundary defined in the *Content-Type* header. Used on the body
    /// itself, *Content-Disposition* has no effect.
    ///
    /// # 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 "*">
    /// ```
    ///
    /// **Note**: filename* [must not](https://tools.ietf.org/html/rfc7578#section-4.2) be used within
    /// *multipart/form-data*.
    ///
    /// # Example
    ///
    /// ```
    /// use actix_web::http::header::{
    ///     Charset, ContentDisposition, DispositionParam, DispositionType,
    ///     ExtendedValue,
    /// };
    ///
    /// let cd1 = ContentDisposition {
    ///     disposition: DispositionType::Attachment,
    ///     parameters: vec![DispositionParam::FilenameExt(ExtendedValue {
    ///         charset: Charset::Iso_8859_1, // The character set for the bytes of the filename
    ///         language_tag: None, // The optional language tag (see `language-tag` crate)
    ///         value: b"\xa9 Copyright 1989.txt".to_vec(), // the actual bytes of the filename
    ///     })],
    /// };
    /// assert!(cd1.is_attachment());
    /// assert!(cd1.get_filename_ext().is_some());
    ///
    /// let cd2 = ContentDisposition {
    ///     disposition: DispositionType::FormData,
    ///     parameters: vec![
    ///         DispositionParam::Name(String::from("file")),
    ///         DispositionParam::Filename(String::from("bill.odt")),
    ///     ],
    /// };
    /// assert_eq!(cd2.get_name(), Some("file")); // field name
    /// assert_eq!(cd2.get_filename(), Some("bill.odt"));
    /// ```
    ///
    /// # WARN
    /// If "filename" parameter is supplied, do not use the file name blindly, check and possibly
    /// change to match local file system conventions if applicable, and do not use directory path
    /// information that may be present. See [RFC2183](https://tools.ietf.org/html/rfc2183#section-2.3)
    /// .
    #[derive(Clone, Debug, PartialEq)]
    pub struct ContentDisposition {
        /// The disposition type
        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` invokes `hv.to_str` which assumes `hv` contains only visible
            //  ASCII characters. So `hv.as_bytes` is necessary here.
            let hv = String::from_utf8(hv.as_bytes().to_vec())
                .map_err(|_| ::error::ParseError::Header)?;
            let (disp_type, mut left) = split_once_and_trim(hv.as_str().trim(), ';');
            if disp_type.is_empty() {
                return Err(::error::ParseError::Header);
            }
            let mut cd = ContentDisposition {
                disposition: disp_type.into(),
                parameters: Vec::new(),
            };

            while !left.is_empty() {
                let (param_name, new_left) = split_once_and_trim(left, '=');
                if param_name.is_empty() || param_name == "*" || new_left.is_empty() {
                    return Err(::error::ParseError::Header);
                }
                left = new_left;
                if param_name.ends_with('*') {
                    // extended parameters
                    let param_name = &param_name[..param_name.len() - 1]; // trim asterisk
                    let (ext_value, new_left) = split_once_and_trim(left, ';');
                    left = new_left;
                    let ext_value = header::parse_extended_value(ext_value)?;

                    let param = if param_name.eq_ignore_ascii_case("filename") {
                        DispositionParam::FilenameExt(ext_value)
                    } else {
                        DispositionParam::UnknownExt(param_name.to_owned(), ext_value)
                    };
                    cd.parameters.push(param);
                } else {
                    // regular parameters
                    let value = if left.starts_with('\"') {
                        // quoted-string: defined in RFC6266 -> RFC2616 Section 3.6
                        let mut escaping = false;
                        let mut quoted_string = vec![];
                        let mut end = None;
                        // search for closing quote
                        for (i, &c) in left.as_bytes().iter().skip(1).enumerate() {
                            if escaping {
                                escaping = false;
                                quoted_string.push(c);
                            } else if c == 0x5c {
                                // backslash
                                escaping = true;
                            } else if c == 0x22 {
                                // double quote
                                end = Some(i + 1); // cuz skipped 1 for the leading quote
                                break;
                            } else {
                                quoted_string.push(c);
                            }
                        }
                        left = &left[end.ok_or(::error::ParseError::Header)? + 1..];
                        left = split_once(left, ';').1.trim_left();
                        // In fact, it should not be Err if the above code is correct.
                        String::from_utf8(quoted_string).map_err(|_| ::error::ParseError::Header)?
                    } else {
                        // token: won't contains semicolon according to RFC 2616 Section 2.2
                        let (token, new_left) = split_once_and_trim(left, ';');
                        left = new_left;
                        token.to_owned()
                    };
                    if value.is_empty() {
                        return Err(::error::ParseError::Header);
                    }

                    let param = if param_name.eq_ignore_ascii_case("name") {
                        DispositionParam::Name(value)
                    } else if param_name.eq_ignore_ascii_case("filename") {
                        DispositionParam::Filename(value)
                    } else {
                        DispositionParam::Unknown(param_name.to_owned(), value)
                    };
                    cd.parameters.push(param);
                }
            }

            Ok(cd)
        }

        /// Returns `true` if it is [`Inline`](DispositionType::Inline).
        pub fn is_inline(&self) -> bool {
            match self.disposition {
                DispositionType::Inline => true,
                _ => false,
            }
        }

        /// Returns `true` if it is [`Attachment`](DispositionType::Attachment).
        pub fn is_attachment(&self) -> bool {
            match self.disposition {
                DispositionType::Attachment => true,
                _ => false,
            }
        }

        /// Returns `true` if it is [`FormData`](DispositionType::FormData).
        pub fn is_form_data(&self) -> bool {
            match self.disposition {
                DispositionType::FormData => true,
                _ => false,
            }
        }

        /// Returns `true` if it is [`Ext`](DispositionType::Ext) and the `disp_type` matches.
        pub fn is_ext<T: AsRef<str>>(&self, disp_type: T) -> bool {
            match self.disposition {
                DispositionType::Ext(ref t)
                    if t.eq_ignore_ascii_case(disp_type.as_ref()) =>
                {
                    true
                }
                _ => false,
            }
        }

        /// Return the value of *name* if exists.
        pub fn get_name(&self) -> Option<&str> {
            self.parameters.iter().filter_map(|p| p.as_name()).nth(0)
        }

        /// Return the value of *filename* if exists.
        pub fn get_filename(&self) -> Option<&str> {
            self.parameters
                .iter()
                .filter_map(|p| p.as_filename())
                .nth(0)
        }

        /// Return the value of *filename\** if exists.
        pub fn get_filename_ext(&self) -> Option<&ExtendedValue> {
            self.parameters
                .iter()
                .filter_map(|p| p.as_filename_ext())
                .nth(0)
        }

        /// Return the value of the parameter which the `name` matches.
        pub fn get_unknown<T: AsRef<str>>(&self, name: T) -> Option<&str> {
            let name = name.as_ref();
            self.parameters
                .iter()
                .filter_map(|p| p.as_unknown(name))
                .nth(0)
        }

        /// Return the value of the extended parameter which the `name` matches.
        pub fn get_unknown_ext<T: AsRef<str>>(&self, name: T) -> Option<&ExtendedValue> {
            let name = name.as_ref();
            self.parameters
                .iter()
                .filter_map(|p| p.as_unknown_ext(name))
                .nth(0)
        }
    }

    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 DispositionType {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            match self {
                DispositionType::Inline => write!(f, "inline"),
                DispositionType::Attachment => write!(f, "attachment"),
                DispositionType::FormData => write!(f, "form-data"),
                DispositionType::Ext(ref s) => write!(f, "{}", s),
            }
        }
    }

    impl fmt::Display for DispositionParam {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            // All ASCII control charaters (0-30, 127) excepting horizontal tab, double quote, and
            // backslash should be escaped in quoted-string (i.e. "foobar").
            // Ref: RFC6266 S4.1 -> RFC2616 S2.2; RFC 7578 S4.2 -> RFC2183 S2 -> ... .
            lazy_static! {
                static ref RE: Regex = Regex::new("[\x01-\x08\x10\x1F\x7F\"\\\\]").unwrap();
            }
            match self {
                DispositionParam::Name(ref value) => write!(f, "name={}", value),
                DispositionParam::Filename(ref value) => {
                    write!(f, "filename=\"{}\"", RE.replace_all(value, "\\$0").as_ref())
                }
                DispositionParam::Unknown(ref name, ref value) => write!(
                    f,
                    "{}=\"{}\"",
                    name,
                    &RE.replace_all(value, "\\$0").as_ref()
                ),
                DispositionParam::FilenameExt(ref ext_value) => {
                    write!(f, "filename*={}", ext_value)
                }
                DispositionParam::UnknownExt(ref name, ref ext_value) => {
                    write!(f, "{}*={}", name, ext_value)
                }
            }
        }
    }

    impl fmt::Display for ContentDisposition {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            write!(f, "{}", self.disposition)?;
            self.parameters
                .iter()
                .map(|param| write!(f, "; {}", param))
                .collect()
        }
    }

    #[cfg(test)]
    mod tests {
        use super::{ContentDisposition, DispositionParam, DispositionType};
        use header::shared::Charset;
        use header::{ExtendedValue, HeaderValue};
        #[test]
        fn test_from_raw_basic() {
            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::FormData,
                parameters: vec![
                    DispositionParam::Unknown("dummy".to_owned(), "3".to_owned()),
                    DispositionParam::Name("upload".to_owned()),
                    DispositionParam::Filename("sample.png".to_owned()),
                ],
            };
            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("image.jpg".to_owned())],
            };
            assert_eq!(a, b);

            let a = HeaderValue::from_static("inline; filename=image.jpg");
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Inline,
                parameters: vec![DispositionParam::Filename("image.jpg".to_owned())],
            };
            assert_eq!(a, b);

            let a = HeaderValue::from_static(
                "attachment; creation-date=\"Wed, 12 Feb 1997 16:29:51 -0500\"",
            );
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Attachment,
                parameters: vec![DispositionParam::Unknown(
                    String::from("creation-date"),
                    "Wed, 12 Feb 1997 16:29:51 -0500".to_owned(),
                )],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_from_raw_extended() {
            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::FilenameExt(ExtendedValue {
                    charset: Charset::Ext(String::from("UTF-8")),
                    language_tag: None,
                    value: 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);

            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::FilenameExt(ExtendedValue {
                    charset: Charset::Ext(String::from("UTF-8")),
                    language_tag: None,
                    value: 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_from_raw_extra_whitespace() {
            let a = HeaderValue::from_static(
                "form-data  ; du-mmy= 3  ; name =upload ; filename =  \"sample.png\"  ; ",
            );
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Unknown("du-mmy".to_owned(), "3".to_owned()),
                    DispositionParam::Name("upload".to_owned()),
                    DispositionParam::Filename("sample.png".to_owned()),
                ],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_from_raw_unordered() {
            let a = HeaderValue::from_static(
                "form-data; dummy=3; filename=\"sample.png\" ; name=upload;",
                // Actually, a trailling semolocon is not compliant. But it is fine to accept.
            );
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Unknown("dummy".to_owned(), "3".to_owned()),
                    DispositionParam::Filename("sample.png".to_owned()),
                    DispositionParam::Name("upload".to_owned()),
                ],
            };
            assert_eq!(a, b);

            let a = HeaderValue::from_str(
                "attachment; filename*=iso-8859-1''foo-%E4.html; filename=\"foo-ä.html\"",
            ).unwrap();
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Attachment,
                parameters: vec![
                    DispositionParam::FilenameExt(ExtendedValue {
                        charset: Charset::Iso_8859_1,
                        language_tag: None,
                        value: b"foo-\xe4.html".to_vec(),
                    }),
                    DispositionParam::Filename("foo-ä.html".to_owned()),
                ],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_from_raw_only_disp() {
            let a = ContentDisposition::from_raw(&HeaderValue::from_static("attachment"))
                .unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Attachment,
                parameters: vec![],
            };
            assert_eq!(a, b);

            let a =
                ContentDisposition::from_raw(&HeaderValue::from_static("inline ;")).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Inline,
                parameters: vec![],
            };
            assert_eq!(a, b);

            let a = ContentDisposition::from_raw(&HeaderValue::from_static(
                "unknown-disp-param",
            )).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Ext(String::from("unknown-disp-param")),
                parameters: vec![],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn from_raw_with_mixed_case() {
            let a = HeaderValue::from_str(
                "InLInE; fIlenAME*=iso-8859-1''foo-%E4.html; filEName=\"foo-ä.html\"",
            ).unwrap();
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::Inline,
                parameters: vec![
                    DispositionParam::FilenameExt(ExtendedValue {
                        charset: Charset::Iso_8859_1,
                        language_tag: None,
                        value: b"foo-\xe4.html".to_vec(),
                    }),
                    DispositionParam::Filename("foo-ä.html".to_owned()),
                ],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn from_raw_with_unicode() {
            /* RFC7578 Section 4.2:
            Some commonly deployed systems use multipart/form-data with file names directly encoded
            including octets outside the US-ASCII range. The encoding used for the file names is
            typically UTF-8, although HTML forms will use the charset associated with the form.

            Mainstream browsers like Firefox (gecko) and Chrome use UTF-8 directly as above.
            (And now, only UTF-8 is handled by this implementation.)
            */
            let a =
                HeaderValue::from_str("form-data; name=upload; filename=\"文件.webp\"")
                    .unwrap();
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Name(String::from("upload")),
                    DispositionParam::Filename(String::from("文件.webp")),
                ],
            };
            assert_eq!(a, b);

            let a =
                HeaderValue::from_str("form-data; name=upload; filename=\"余固知謇謇之為患兮，忍而不能舍也.pptx\"").unwrap();
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Name(String::from("upload")),
                    DispositionParam::Filename(String::from(
                        "余固知謇謇之為患兮，忍而不能舍也.pptx",
                    )),
                ],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_from_raw_escape() {
            let a = HeaderValue::from_static(
                "form-data; dummy=3; name=upload; filename=\"s\\amp\\\"le.png\"",
            );
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Unknown("dummy".to_owned(), "3".to_owned()),
                    DispositionParam::Name("upload".to_owned()),
                    DispositionParam::Filename(
                        ['s', 'a', 'm', 'p', '\"', 'l', 'e', '.', 'p', 'n', 'g']
                            .iter()
                            .collect(),
                    ),
                ],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_from_raw_semicolon() {
            let a =
                HeaderValue::from_static("form-data; filename=\"A semicolon here;.pdf\"");
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![DispositionParam::Filename(String::from(
                    "A semicolon here;.pdf",
                ))],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_from_raw_uncessary_percent_decode() {
            let a = HeaderValue::from_static(
                "form-data; name=photo; filename=\"%74%65%73%74%2e%70%6e%67\"", // Should not be decoded!
            );
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Name("photo".to_owned()),
                    DispositionParam::Filename(String::from("%74%65%73%74%2e%70%6e%67")),
                ],
            };
            assert_eq!(a, b);

            let a = HeaderValue::from_static(
                "form-data; name=photo; filename=\"%74%65%73%74.png\"",
            );
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let b = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Name("photo".to_owned()),
                    DispositionParam::Filename(String::from("%74%65%73%74.png")),
                ],
            };
            assert_eq!(a, b);
        }

        #[test]
        fn test_from_raw_param_value_missing() {
            let a = HeaderValue::from_static("form-data; name=upload ; filename=");
            assert!(ContentDisposition::from_raw(&a).is_err());

            let a = HeaderValue::from_static("attachment; dummy=; filename=invoice.pdf");
            assert!(ContentDisposition::from_raw(&a).is_err());

            let a = HeaderValue::from_static("inline; filename=  ");
            assert!(ContentDisposition::from_raw(&a).is_err());
        }

        #[test]
        fn test_from_raw_param_name_missing() {
            let a = HeaderValue::from_static("inline; =\"test.txt\"");
            assert!(ContentDisposition::from_raw(&a).is_err());

            let a = HeaderValue::from_static("inline; =diary.odt");
            assert!(ContentDisposition::from_raw(&a).is_err());

            let a = HeaderValue::from_static("inline; =");
            assert!(ContentDisposition::from_raw(&a).is_err());
        }

        #[test]
        fn test_display_extended() {
            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=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
            );
        }

        #[test]
        fn test_display_quote() {
            let as_string = "form-data; name=upload; filename=\"Quote\\\"here.png\"";
            as_string
                .find(['\\', '\"'].iter().collect::<String>().as_str())
                .unwrap(); // ensure `\"` is there
            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);
        }

        #[test]
        fn test_display_space_tab() {
            let as_string = "form-data; name=upload; filename=\"Space here.png\"";
            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: ContentDisposition = ContentDisposition {
                disposition: DispositionType::Inline,
                parameters: vec![DispositionParam::Filename(String::from("Tab\there.png"))],
            };
            let display_rendered = format!("{}", a);
            assert_eq!("inline; filename=\"Tab\x09here.png\"", display_rendered);
        }

        #[test]
        fn test_display_control_characters() {
            /* let a = "attachment; filename=\"carriage\rreturn.png\"";
            let a = HeaderValue::from_static(a);
            let a: ContentDisposition = ContentDisposition::from_raw(&a).unwrap();
            let display_rendered = format!("{}", a);
            assert_eq!(
                "attachment; filename=\"carriage\\\rreturn.png\"",
                display_rendered
            );*/
     // No way to create a HeaderValue containing a carriage return.

            let a: ContentDisposition = ContentDisposition {
                disposition: DispositionType::Inline,
                parameters: vec![DispositionParam::Filename(String::from("bell\x07.png"))],
            };
            let display_rendered = format!("{}", a);
            assert_eq!("inline; filename=\"bell\\\x07.png\"", display_rendered);
        }

        #[test]
        fn test_param_methods() {
            let param = DispositionParam::Filename(String::from("sample.txt"));
            assert!(param.is_filename());
            assert_eq!(param.as_filename().unwrap(), "sample.txt");

            let param = DispositionParam::Unknown(String::from("foo"), String::from("bar"));
            assert!(param.is_unknown("foo"));
            assert_eq!(param.as_unknown("fOo"), Some("bar"));
        }

        #[test]
        fn test_disposition_methods() {
            let cd = ContentDisposition {
                disposition: DispositionType::FormData,
                parameters: vec![
                    DispositionParam::Unknown("dummy".to_owned(), "3".to_owned()),
                    DispositionParam::Name("upload".to_owned()),
                    DispositionParam::Filename("sample.png".to_owned()),
                ],
            };
            assert_eq!(cd.get_name(), Some("upload"));
            assert_eq!(cd.get_unknown("dummy"), Some("3"));
            assert_eq!(cd.get_filename(), Some("sample.png"));
            assert_eq!(cd.get_unknown_ext("dummy"), None);
            assert_eq!(cd.get_unknown("duMMy"), Some("3"));
        }
    }

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