Struct websocket::header::ETag

pub struct ETag(pub EntityTag);

ETag header, defined in RFC7232

The ETag header field in a response provides the current entity-tag for the selected representation, as determined at the conclusion of handling the request. An entity-tag is an opaque validator for differentiating between multiple representations of the same resource, regardless of whether those multiple representations are due to resource state changes over time, content negotiation resulting in multiple representations being valid at the same time, or both. An entity-tag consists of an opaque quoted string, possibly prefixed by a weakness indicator.

ABNF

ETag       = entity-tag

Example values

• "xyzzy"
• W/"xyzzy"
• ""

Examples

use hyper::header::{Headers, ETag, EntityTag};

let mut headers = Headers::new();
headers.set(ETag(EntityTag::new(false, "xyzzy".to_owned())));

use hyper::header::{Headers, ETag, EntityTag};

let mut headers = Headers::new();
headers.set(ETag(EntityTag::new(true, "xyzzy".to_owned())));

Methods from Deref<Target = EntityTag>

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 DerefMut for ETag

fn deref_mut(&mut self) -> &mut EntityTag

Mutably dereferences the value.

impl Debug for ETag

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for ETag

type Target = EntityTag

The resulting type after dereferencing.

fn deref(&self) -> &EntityTag

Dereferences the value.

impl Display for ETag

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq<ETag> for ETag

fn eq(&self, other: &ETag) -> bool

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

fn ne(&self, other: &ETag) -> bool

This method tests for !=.

impl HeaderFormat for ETag

fn fmt_header(&self, f: &mut Formatter) -> Result<(), Error>

Format a header to be output into a TcpStream.

impl Header for ETag

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header(raw: &[Vec<u8>]) -> Result<ETag, Error>

Parse a header from a raw stream of bytes.

impl Clone for ETag

fn clone(&self) -> ETag

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.