Struct RevisionEtag 

pub struct RevisionEtag<'a> { /* private fields */ }

Formats and parses strong revision ETags of the form "<prefix><revision>".

The prefix is compared byte for byte, so it is case-sensitive. The revision is canonical decimal: no sign, no leading zeros, and 0 is allowed.

Implementations

impl<'a> RevisionEtag<'a>

pub const fn new(prefix: &'a str) -> Self

Creates a codec for a fixed prefix, such as "rev-".

Panics

Panics when the prefix is invalid. In a const item the panic is a compile error. Use RevisionEtag::try_new for prefixes built at runtime.

pub const fn try_new(prefix: &'a str) -> Result<Self, InvalidEtagPrefix>

Creates a codec for a prefix built at runtime.

pub const fn prefix(&self) -> &'a str

Returns the prefix.

pub fn format(&self, revision: Revision) -> String

Returns the quoted ETag, for example "rev-42" including the quotes.

pub fn header_value(&self, revision: Revision) -> HeaderValue

Returns the quoted ETag as an ETag response header value.

pub fn parse(&self, value: &HeaderValue) -> Result<Revision, InvalidIfMatch>

Parses one If-Match field value.

pub fn required_if_match( &self, headers: &HeaderMap, ) -> Result<Revision, PreconditionError>

Reads the revision from a route that requires If-Match.

A missing header returns PreconditionError::Required.

pub fn optional_if_match( &self, headers: &HeaderMap, ) -> Result<Option<Revision>, PreconditionError>

Reads the revision from a route where If-Match is optional.

A missing header returns Ok(None), which permits an unconditional write.

Trait Implementations

impl<'a> Clone for RevisionEtag<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for RevisionEtag<'a>

impl<'a> Debug for RevisionEtag<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for RevisionEtag<'a>

impl<'a> PartialEq for RevisionEtag<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for RevisionEtag<'a>