# accept.rs.html -- source
Source to the Rust file `src/header/common/accept.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

    use header::{qitem, QualityItem};
    use http::header as http;
    use mime::{self, Mime};

    header! {
        /// `Accept` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.2)
        ///
        /// The `Accept` header field can be used by user agents to specify
        /// response media types that are acceptable.  Accept header fields can
        /// be used to indicate that the request is specifically limited to a
        /// small set of desired types, as in the case of a request for an
        /// in-line image
        ///
        /// # ABNF
        ///
        /// ```text
        /// Accept = #( media-range [ accept-params ] )
        ///
        /// media-range    = ( "*/*"
        ///                  / ( type "/" "*" )
        ///                  / ( type "/" subtype )
        ///                  ) *( OWS ";" OWS parameter )
        /// accept-params  = weight *( accept-ext )
        /// accept-ext = OWS ";" OWS token [ "=" ( token / quoted-string ) ]
        /// ```
        ///
        /// # Example values
        /// * `audio/*; q=0.2, audio/basic`
        /// * `text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c`
        ///
        /// # Examples
        /// ```rust
        /// # extern crate actix_web;
        /// extern crate mime;
        /// use actix_web::HttpResponse;
        /// use actix_web::http::header::{Accept, qitem};
        ///
        /// # fn main() {
        /// let mut builder = HttpResponse::Ok();
        ///
        /// builder.set(
        ///     Accept(vec![
        ///         qitem(mime::TEXT_HTML),
        ///     ])
        /// );
        /// # }
        /// ```
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// extern crate mime;
        /// use actix_web::HttpResponse;
        /// use actix_web::http::header::{Accept, qitem};
        ///
        /// # fn main() {
        /// let mut builder = HttpResponse::Ok();
        ///
        /// builder.set(
        ///     Accept(vec![
        ///         qitem(mime::APPLICATION_JSON),
        ///     ])
        /// );
        /// # }
        /// ```
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// extern crate mime;
        /// use actix_web::HttpResponse;
        /// use actix_web::http::header::{Accept, QualityItem, q, qitem};
        ///
        /// # fn main() {
        /// let mut builder = HttpResponse::Ok();
        ///
        /// builder.set(
        ///     Accept(vec![
        ///         qitem(mime::TEXT_HTML),
        ///         qitem("application/xhtml+xml".parse().unwrap()),
        ///         QualityItem::new(
        ///             mime::TEXT_XML,
        ///             q(900)
        ///         ),
        ///         qitem("image/webp".parse().unwrap()),
        ///         QualityItem::new(
        ///             mime::STAR_STAR,
        ///             q(800)
        ///         ),
        ///     ])
        /// );
        /// # }
        /// ```
        (Accept, http::ACCEPT) => (QualityItem<Mime>)+

        test_accept {
            // Tests from the RFC
             test_header!(
                test1,
                vec![b"audio/*; q=0.2, audio/basic"],
                Some(HeaderField(vec![
                    QualityItem::new("audio/*".parse().unwrap(), q(200)),
                    qitem("audio/basic".parse().unwrap()),
                    ])));
            test_header!(
                test2,
                vec![b"text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c"],
                Some(HeaderField(vec![
                    QualityItem::new(TEXT_PLAIN, q(500)),
                    qitem(TEXT_HTML),
                    QualityItem::new(
                        "text/x-dvi".parse().unwrap(),
                        q(800)),
                    qitem("text/x-c".parse().unwrap()),
                    ])));
            // Custom tests
            test_header!(
                test3,
                vec![b"text/plain; charset=utf-8"],
                Some(Accept(vec![
                    qitem(TEXT_PLAIN_UTF_8),
                    ])));
            test_header!(
                test4,
                vec![b"text/plain; charset=utf-8; q=0.5"],
                Some(Accept(vec![
                    QualityItem::new(TEXT_PLAIN_UTF_8,
                        q(500)),
                ])));

            #[test]
            fn test_fuzzing1() {
                use test::TestRequest;
                let req = TestRequest::with_header(super::http::ACCEPT, "chunk#;e").finish();
                let header = Accept::parse(&req);
                assert!(header.is_ok());
            }
        }
    }

    impl Accept {
        /// A constructor to easily create `Accept: */*`.
        pub fn star() -> Accept {
            Accept(vec![qitem(mime::STAR_STAR)])
        }

        /// A constructor to easily create `Accept: application/json`.
        pub fn json() -> Accept {
            Accept(vec![qitem(mime::APPLICATION_JSON)])
        }

        /// A constructor to easily create `Accept: text/*`.
        pub fn text() -> Accept {
            Accept(vec![qitem(mime::TEXT_STAR)])
        }

        /// A constructor to easily create `Accept: image/*`.
        pub fn image() -> Accept {
            Accept(vec![qitem(mime::IMAGE_STAR)])
        }
    }

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