Skip to main content

Operation

Enum Operation 

Source
pub enum Operation {
    Eq(HeaderName, HeaderValue),
    Exist(HeaderName),
    In(HeaderName, Vec<HeaderValue>),
    Contains(HeaderName, String),
    Regex(HeaderName, Regex),
}
Expand description

Matching operations for HTTP headers.

These operations can be used with both request and response headers.

§Variants

  • Eq: Exact match on header value
  • Exist: Header presence check (any value)
  • In: Match any of several values
  • Contains: Substring match within header value
  • Regex: Pattern match using regular expression

§Examples

use hitbox_http::predicates::header::Operation;
use http::header::CONTENT_TYPE;

// Match exact header value
let op = Operation::Eq(
    CONTENT_TYPE,
    "application/json".parse().unwrap(),
);

// Check header exists
let op = Operation::Exist(CONTENT_TYPE);

// Match substring in header value
let op = Operation::Contains(CONTENT_TYPE, "json".to_string());

Using regex for complex patterns:

use hitbox_http::predicates::header::Operation;
use http::header::ACCEPT;
use regex::Regex;

// Match Accept headers containing version info
let op = Operation::Regex(
    ACCEPT,
    Regex::new(r"application/vnd\.api\+json; version=\d+").unwrap(),
);

Variants§

§

Eq(HeaderName, HeaderValue)

Use when you need an exact match on a known header value.

Best for specific content types, authorization schemes, or cache directives.

§

Exist(HeaderName)

Use when presence of a header determines cacheability, regardless of value.

Best for checking optional headers like Authorization or custom API headers.

§

In(HeaderName, Vec<HeaderValue>)

Use when any of several values should trigger caching.

Best for allowing multiple content types or API versions.

§

Contains(HeaderName, String)

Use when matching partial values in complex headers.

Best for content types with parameters (e.g., "json" in application/json; charset=utf-8).

§

Regex(HeaderName, Regex)

Use when header values follow a pattern.

Best for version strings, custom formats, or extracting structured data.

Implementations§

Source§

impl Operation

Source

pub fn check(&self, headers: &HeaderMap) -> bool

Check if the operation matches the headers.

Trait Implementations§

Source§

impl Debug for Operation

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more