     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

    use header::{EntityTag, IF_NONE_MATCH};

    header! {
        /// `If-None-Match` header, defined in
        /// [RFC7232](https://tools.ietf.org/html/rfc7232#section-3.2)
        ///
        /// The `If-None-Match` header field makes the request method conditional
        /// on a recipient cache or origin server either not having any current
        /// representation of the target resource, when the field-value is "*",
        /// or having a selected representation with an entity-tag that does not
        /// match any of those listed in the field-value.
        ///
        /// A recipient MUST use the weak comparison function when comparing
        /// entity-tags for If-None-Match (Section 2.3.2), since weak entity-tags
        /// can be used for cache validation even if there have been changes to
        /// the representation data.
        ///
        /// # ABNF
        ///
        /// ```text
        /// If-None-Match = "*" / 1#entity-tag
        /// ```
        ///
        /// # Example values
        ///
        /// * `"xyzzy"`
        /// * `W/"xyzzy"`
        /// * `"xyzzy", "r2d2xxxx", "c3piozzzz"`
        /// * `W/"xyzzy", W/"r2d2xxxx", W/"c3piozzzz"`
        /// * `*`
        ///
        /// # Examples
        ///
        /// ```rust
        /// use actix_web::HttpResponse;
        /// use actix_web::http::header::IfNoneMatch;
        ///
        /// let mut builder = HttpResponse::Ok();
        /// builder.set(IfNoneMatch::Any);
        /// ```
        ///
        /// ```rust
        /// use actix_web::HttpResponse;
        /// use actix_web::http::header::{IfNoneMatch, EntityTag};
        ///
        /// let mut builder = HttpResponse::Ok();
        /// builder.set(
        ///     IfNoneMatch::Items(vec![
        ///         EntityTag::new(false, "xyzzy".to_owned()),
        ///         EntityTag::new(false, "foobar".to_owned()),
        ///         EntityTag::new(false, "bazquux".to_owned()),
        ///     ])
        /// );
        /// ```
        (IfNoneMatch, IF_NONE_MATCH) => {Any / (EntityTag)+}

        test_if_none_match {
            test_header!(test1, vec![b"\"xyzzy\""]);
            test_header!(test2, vec![b"W/\"xyzzy\""]);
            test_header!(test3, vec![b"\"xyzzy\", \"r2d2xxxx\", \"c3piozzzz\""]);
            test_header!(test4, vec![b"W/\"xyzzy\", W/\"r2d2xxxx\", W/\"c3piozzzz\""]);
            test_header!(test5, vec![b"*"]);
        }
    }

    #[cfg(test)]
    mod tests {
        use super::IfNoneMatch;
        use header::{EntityTag, Header, IF_NONE_MATCH};
        use test::TestRequest;

        #[test]
        fn test_if_none_match() {
            let mut if_none_match: Result<IfNoneMatch, _>;

            let req = TestRequest::with_header(IF_NONE_MATCH, "*").finish();
            if_none_match = Header::parse(&req);
            assert_eq!(if_none_match.ok(), Some(IfNoneMatch::Any));

            let req =
                TestRequest::with_header(IF_NONE_MATCH, &b"\"foobar\", W/\"weak-etag\""[..])
                    .finish();

            if_none_match = Header::parse(&req);
            let mut entities: Vec<EntityTag> = Vec::new();
            let foobar_etag = EntityTag::new(false, "foobar".to_owned());
            let weak_etag = EntityTag::new(true, "weak-etag".to_owned());
            entities.push(foobar_etag);
            entities.push(weak_etag);
            assert_eq!(if_none_match.ok(), Some(IfNoneMatch::Items(entities)));
        }
    }

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