Struct actix_web::http::header::ETag

pub struct ETag(pub EntityTag);

ETag header, defined in RFC 7232 §2.3

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 actix_web::HttpResponse;
use actix_web::http::header::{ETag, EntityTag};

let mut builder = HttpResponse::Ok();
builder.insert_header(
    ETag(EntityTag::new_strong("xyzzy".to_owned()))
);

use actix_web::HttpResponse;
use actix_web::http::header::{ETag, EntityTag};

let mut builder = HttpResponse::Ok();
builder.insert_header(
    ETag(EntityTag::new_weak("xyzzy".to_owned()))
);

Tuple Fields

0: EntityTag

Methods from Deref<Target = EntityTag>

pub fn tag(&self) -> &str

Returns tag.

pub fn set_tag(&mut self, tag: impl Into<String>)

Sets 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

Returns the inverse of strong_eq().

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

Returns inverse of weak_eq().

Trait Implementations

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.

impl Debug for ETag

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

Formats the value using the given formatter.

impl Deref for ETag

type Target = EntityTag

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ETag

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for ETag

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

Formats the value using the given formatter.

impl Header for ETag

fn name() -> HeaderName

Returns the name of the header field.

fn parse<M: HttpMessage>(msg: &M) -> Result<Self, ParseError>

Parse the header from a HTTP message.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryIntoHeaderValue for ETag

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.

fn try_into_value(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a HeaderValue.

impl Eq for ETag

impl StructuralEq for ETag

impl StructuralPartialEq for ETag