Struct websocket::header::EntityTag

[+] Show declaration

pub struct EntityTag {
    pub weak: bool,
    // some fields omitted
}

[−] Expand description

An entity tag, defined in RFC7232

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

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

Fields

weak: bool

[−] Expand description

Weakness indicator for the tag

Implementations

impl EntityTag[−]

pub fn new(weak: bool, tag: String) -> EntityTag[−]

Constructs a new EntityTag.

Panics

If the tag contains invalid characters.

pub fn weak(tag: String) -> EntityTag[−]

Constructs a new weak EntityTag.

Panics

If the tag contains invalid characters.

pub fn strong(tag: String) -> EntityTag[−]

Constructs a new strong EntityTag.

Panics

If the tag contains invalid characters.

pub fn tag(&self) -> &str[−]

Get the tag.

pub fn set_tag(&mut self, tag: String)[−]

Set the tag.

Panics

If the tag contains invalid characters.

pub fn strong_eq(&self, other: &EntityTag) -> bool[−]

For strong comparison two entity-tags are equivalent if both are not weak and their opaque-tags match character-by-character.

pub fn weak_eq(&self, other: &EntityTag) -> bool[−]

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 strong_ne(&self, other: &EntityTag) -> bool[−]

The inverse of EntityTag.strong_eq().

pub fn weak_ne(&self, other: &EntityTag) -> bool[−]

The inverse of EntityTag.weak_eq().

Trait Implementations

impl Clone for EntityTag[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> EntityTag[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for EntityTag[+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Display for EntityTag[+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Eq for EntityTag

impl FromStr for EntityTag[+]

[+] Show hidden undocumented items

type Err = Error

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<EntityTag, Error>[−]

Parses a string s to return a value of this type.

impl PartialEq<EntityTag> for EntityTag[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &EntityTag) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &EntityTag) -> bool[−]

This method tests for !=.

impl StructuralEq for EntityTag

impl StructuralPartialEq for EntityTag