Enum http_types::conditional::ETag

pub enum ETag {
    Strong(String),
    Weak(String),
}

HTTP Entity Tags.

ETags provide an ID for a particular resource, enabling clients and servers to reason about caches and make conditional requests.

Specifications

• RFC 7232, section 2.3: ETag

Examples

use http_types::Response;
use http_types::conditional::ETag;

let etag = ETag::new("0xcafebeef".to_string());

let mut res = Response::new(200);
etag.apply(&mut res);

let etag = ETag::from_headers(res)?.unwrap();
assert_eq!(etag, ETag::Strong(String::from("0xcafebeef")));

Variants

Strong

An ETag using strong validation.

Tuple Fields of Strong

0: String

Weak

An ETag using weak validation.

Tuple Fields of Weak

0: String

Implementations

impl ETag

pub fn new(s: String) -> Self

Create a new ETag that uses strong validation.

pub fn new_weak(s: String) -> Self

Create a new ETag that uses weak validation.

pub fn from_headers(headers: impl AsRef<Headers>) -> Result<Option<Self>>

Create a new instance from headers.

Only a single ETag per resource is assumed to exist. If multiple ETag headers are found the last one is used.

pub fn apply(&self, headers: impl AsMut<Headers>)

Sets the ETag header.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

pub fn is_strong(&self) -> bool

Returns true if the ETag is a Strong value.

pub fn is_weak(&self) -> bool

Returns true if the ETag is a Weak value.

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

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

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

type Iter = IntoIter<HeaderValue>

Returned iterator over header values which this type may correspond to.

fn to_header_values(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved HeaderValues.

impl Eq for ETag

impl StructuralEq for ETag

impl StructuralPartialEq for ETag