Enum http_sig::PseudoHeader

#[non_exhaustive]pub enum PseudoHeader {
    RequestTarget,
    Created,
    Expires,
}

Pseudo-headers are used to incorporate additional information into a HTTP signature for which there is no corresponding HTTP header.

They are described as "special headers" in the draft specification: https://tools.ietf.org/id/draft-cavage-http-signatures-12.html#canonicalization

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RequestTarget

The (request-target) pseudo-header is constructed by joining the lower-cased request method (get, post, etc.) and the request path (/some/page?foo=1) with a single space character.

For example: get /index.html

Created

Passed as part of the auth header

Expires

Passed as part of the auth header

Methods

impl PseudoHeader

pub fn as_str(&self) -> &str

Returns the string representation of the pseudo-header.

Trait Implementations

impl Clone for PseudoHeader

fn clone(&self) -> PseudoHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PseudoHeader

impl Debug for PseudoHeader

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

Formats the value using the given formatter.

impl Eq for PseudoHeader

impl From<PseudoHeader> for Header

fn from(other: PseudoHeader) -> Self

Performs the conversion.

impl FromStr for PseudoHeader

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PseudoHeader, Self::Err>

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

impl Ord for PseudoHeader

fn cmp(&self, other: &PseudoHeader) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<PseudoHeader> for PseudoHeader

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<PseudoHeader> for PseudoHeader

fn partial_cmp(&self, other: &PseudoHeader) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for PseudoHeader

impl StructuralPartialEq for PseudoHeader