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

    use header::{HeaderValue, IntoHeaderValue, InvalidHeaderValueBytes, Writer};
    use std::fmt::{self, Display, Write};
    use std::str::FromStr;

    /// check that each char in the slice is either:
    /// 1. `%x21`, or
    /// 2. in the range `%x23` to `%x7E`, or
    /// 3. above `%x80`
    fn check_slice_validity(slice: &str) -> bool {
        slice
            .bytes()
            .all(|c| c == b'\x21' || (c >= b'\x23' && c <= b'\x7e') | (c >= b'\x80'))
    }

    /// An entity tag, defined in [RFC7232](https://tools.ietf.org/html/rfc7232#section-2.3)
    ///
    /// An entity tag consists of a string enclosed by two literal double quotes.
    /// Preceding the first double quote is an optional weakness indicator,
    /// which always looks like `W/`. Examples for valid tags are `"xyzzy"` and
    /// `W/"xyzzy"`.
    ///
    /// # ABNF
    ///
    /// ```text
    /// entity-tag = [ weak ] opaque-tag
    /// weak       = %x57.2F ; "W/", case-sensitive
    /// opaque-tag = DQUOTE *etagc DQUOTE
    /// etagc      = %x21 / %x23-7E / obs-text
    ///            ; VCHAR except double quotes, plus obs-text
    /// ```
    ///
    /// # Comparison
    /// To check if two entity tags are equivalent in an application always use the
    /// `strong_eq` or `weak_eq` methods based on the context of the Tag. Only use
    /// `==` to check if two tags are identical.
    ///
    /// The example below shows the results for a set of entity-tag pairs and
    /// both the weak and strong comparison function results:
    ///
    /// | `ETag 1`| `ETag 2`| Strong Comparison | Weak Comparison |
    /// |---------|---------|-------------------|-----------------|
    /// | `W/"1"` | `W/"1"` | no match          | match           |
    /// | `W/"1"` | `W/"2"` | no match          | no match        |
    /// | `W/"1"` | `"1"`   | no match          | match           |
    /// | `"1"`   | `"1"`   | match             | match           |
    #[derive(Clone, Debug, Eq, PartialEq)]
    pub struct EntityTag {
        /// Weakness indicator for the tag
        pub weak: bool,
        /// The opaque string in between the DQUOTEs
        tag: String,
    }

    impl EntityTag {
        /// Constructs a new EntityTag.
        /// # Panics
        /// If the tag contains invalid characters.
        pub fn new(weak: bool, tag: String) -> EntityTag {
            assert!(check_slice_validity(&tag), "Invalid tag: {:?}", tag);
            EntityTag { weak, tag }
        }

        /// Constructs a new weak EntityTag.
        /// # Panics
        /// If the tag contains invalid characters.
        pub fn weak(tag: String) -> EntityTag {
            EntityTag::new(true, tag)
        }

        /// Constructs a new strong EntityTag.
        /// # Panics
        /// If the tag contains invalid characters.
        pub fn strong(tag: String) -> EntityTag {
            EntityTag::new(false, tag)
        }

        /// Get the tag.
        pub fn tag(&self) -> &str {
            self.tag.as_ref()
        }

        /// Set the tag.
        /// # Panics
        /// If the tag contains invalid characters.
        pub fn set_tag(&mut self, tag: String) {
            assert!(check_slice_validity(&tag), "Invalid tag: {:?}", tag);
            self.tag = tag
        }

        /// For strong comparison two entity-tags are equivalent if both are not
        /// weak and their opaque-tags match character-by-character.
        pub fn strong_eq(&self, other: &EntityTag) -> bool {
            !self.weak && !other.weak && self.tag == other.tag
        }

        /// For weak comparison two entity-tags are equivalent if their
        /// opaque-tags match character-by-character, regardless of either or
        /// both being tagged as "weak".
        pub fn weak_eq(&self, other: &EntityTag) -> bool {
            self.tag == other.tag
        }

        /// The inverse of `EntityTag.strong_eq()`.
        pub fn strong_ne(&self, other: &EntityTag) -> bool {
            !self.strong_eq(other)
        }

        /// The inverse of `EntityTag.weak_eq()`.
        pub fn weak_ne(&self, other: &EntityTag) -> bool {
            !self.weak_eq(other)
        }
    }

    impl Display for EntityTag {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            if self.weak {
                write!(f, "W/\"{}\"", self.tag)
            } else {
                write!(f, "\"{}\"", self.tag)
            }
        }
    }

    impl FromStr for EntityTag {
        type Err = ::error::ParseError;

        fn from_str(s: &str) -> Result<EntityTag, ::error::ParseError> {
            let length: usize = s.len();
            let slice = &s[..];
            // Early exits if it doesn't terminate in a DQUOTE.
            if !slice.ends_with('"') || slice.len() < 2 {
                return Err(::error::ParseError::Header);
            }
            // The etag is weak if its first char is not a DQUOTE.
            if slice.len() >= 2
                && slice.starts_with('"')
                && check_slice_validity(&slice[1..length - 1])
            {
                // No need to check if the last char is a DQUOTE,
                // we already did that above.
                return Ok(EntityTag {
                    weak: false,
                    tag: slice[1..length - 1].to_owned(),
                });
            } else if slice.len() >= 4
                && slice.starts_with("W/\"")
                && check_slice_validity(&slice[3..length - 1])
            {
                return Ok(EntityTag {
                    weak: true,
                    tag: slice[3..length - 1].to_owned(),
                });
            }
            Err(::error::ParseError::Header)
        }
    }

    impl IntoHeaderValue for EntityTag {
        type Error = InvalidHeaderValueBytes;

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

    #[cfg(test)]
    mod tests {
        use super::EntityTag;

        #[test]
        fn test_etag_parse_success() {
            // Expected success
            assert_eq!(
                "\"foobar\"".parse::<EntityTag>().unwrap(),
                EntityTag::strong("foobar".to_owned())
            );
            assert_eq!(
                "\"\"".parse::<EntityTag>().unwrap(),
                EntityTag::strong("".to_owned())
            );
            assert_eq!(
                "W/\"weaktag\"".parse::<EntityTag>().unwrap(),
                EntityTag::weak("weaktag".to_owned())
            );
            assert_eq!(
                "W/\"\x65\x62\"".parse::<EntityTag>().unwrap(),
                EntityTag::weak("\x65\x62".to_owned())
            );
            assert_eq!(
                "W/\"\"".parse::<EntityTag>().unwrap(),
                EntityTag::weak("".to_owned())
            );
        }

        #[test]
        fn test_etag_parse_failures() {
            // Expected failures
            assert!("no-dquotes".parse::<EntityTag>().is_err());
            assert!(
                "w/\"the-first-w-is-case-sensitive\""
                    .parse::<EntityTag>()
                    .is_err()
            );
            assert!("".parse::<EntityTag>().is_err());
            assert!("\"unmatched-dquotes1".parse::<EntityTag>().is_err());
            assert!("unmatched-dquotes2\"".parse::<EntityTag>().is_err());
            assert!("matched-\"dquotes\"".parse::<EntityTag>().is_err());
        }

        #[test]
        fn test_etag_fmt() {
            assert_eq!(
                format!("{}", EntityTag::strong("foobar".to_owned())),
                "\"foobar\""
            );
            assert_eq!(format!("{}", EntityTag::strong("".to_owned())), "\"\"");
            assert_eq!(
                format!("{}", EntityTag::weak("weak-etag".to_owned())),
                "W/\"weak-etag\""
            );
            assert_eq!(
                format!("{}", EntityTag::weak("\u{0065}".to_owned())),
                "W/\"\x65\""
            );
            assert_eq!(format!("{}", EntityTag::weak("".to_owned())), "W/\"\"");
        }

        #[test]
        fn test_cmp() {
            // | ETag 1  | ETag 2  | Strong Comparison | Weak Comparison |
            // |---------|---------|-------------------|-----------------|
            // | `W/"1"` | `W/"1"` | no match          | match           |
            // | `W/"1"` | `W/"2"` | no match          | no match        |
            // | `W/"1"` | `"1"`   | no match          | match           |
            // | `"1"`   | `"1"`   | match             | match           |
            let mut etag1 = EntityTag::weak("1".to_owned());
            let mut etag2 = EntityTag::weak("1".to_owned());
            assert!(!etag1.strong_eq(&etag2));
            assert!(etag1.weak_eq(&etag2));
            assert!(etag1.strong_ne(&etag2));
            assert!(!etag1.weak_ne(&etag2));

            etag1 = EntityTag::weak("1".to_owned());
            etag2 = EntityTag::weak("2".to_owned());
            assert!(!etag1.strong_eq(&etag2));
            assert!(!etag1.weak_eq(&etag2));
            assert!(etag1.strong_ne(&etag2));
            assert!(etag1.weak_ne(&etag2));

            etag1 = EntityTag::weak("1".to_owned());
            etag2 = EntityTag::strong("1".to_owned());
            assert!(!etag1.strong_eq(&etag2));
            assert!(etag1.weak_eq(&etag2));
            assert!(etag1.strong_ne(&etag2));
            assert!(!etag1.weak_ne(&etag2));

            etag1 = EntityTag::strong("1".to_owned());
            etag2 = EntityTag::strong("1".to_owned());
            assert!(etag1.strong_eq(&etag2));
            assert!(etag1.weak_eq(&etag2));
            assert!(!etag1.strong_ne(&etag2));
            assert!(!etag1.weak_ne(&etag2));
        }
    }

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