Enum HeaderMatcher 

#[non_exhaustive]
pub enum HeaderMatcher {
    Equals(Value),
    Regex(String),
    Exists,
}

A matcher over a received header value.

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.

Equals(Value)

The header value equals the given JSON value.

Regex(String)

The header value (a string) matches the given regular expression.

Exists

The header key is present (any value, including JSON null).

Implementations

impl HeaderMatcher

pub fn matches(&self, actual: Option<&Value>) -> bool

Evaluate this matcher against a received header value.

pub fn regex_pattern(&self) -> Option<&str>

The regex pattern, if this is a HeaderMatcher::Regex.

pub fn mismatch_note(&self, actual: Option<&Value>) -> Option<&'static str>

A short note explaining why a non-matching header failed, when the failure is a shape mismatch rather than a value mismatch.

Trait Implementations

impl Clone for HeaderMatcher

fn clone(&self) -> HeaderMatcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderMatcher

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

Formats the value using the given formatter.

impl Display for HeaderMatcher

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

Formats the value using the given formatter.