Struct HttpMatcher

pub struct HttpMatcher<State, Body> { /* private fields */ }

A matcher that is used to match an http Request

Implementations

impl<State, Body> HttpMatcher<State, Body>

pub fn method(method: MethodMatcher) -> Self

Create a new matcher that matches one or more HTTP methods.

See MethodMatcher for more information.

pub fn and_method(self, method: MethodMatcher) -> Self

Create a matcher that also matches one or more HTTP methods on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method(self, method: MethodMatcher) -> Self

Create a matcher that can also match one or more HTTP methods as an alternative to the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_delete() -> Self

Create a new matcher that matches MethodMatcher::DELETE requests.

See MethodMatcher for more information.

pub fn and_method_delete(self) -> Self

Add a new matcher that also matches MethodMatcher::DELETE on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_delete(self) -> Self

Add a new matcher that can also match MethodMatcher::DELETE as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_get() -> Self

Create a new matcher that matches MethodMatcher::GET requests.

See MethodMatcher for more information.

pub fn and_method_get(self) -> Self

Add a new matcher that also matches MethodMatcher::GET on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_get(self) -> Self

Add a new matcher that can also match MethodMatcher::GET as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_head() -> Self

Create a new matcher that matches MethodMatcher::HEAD requests.

See MethodMatcher for more information.

pub fn and_method_head(self) -> Self

Add a new matcher that also matches MethodMatcher::HEAD on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_head(self) -> Self

Add a new matcher that can also match MethodMatcher::HEAD as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_options() -> Self

Create a new matcher that matches MethodMatcher::OPTIONS requests.

See MethodMatcher for more information.

pub fn and_method_options(self) -> Self

Add a new matcher that also matches MethodMatcher::OPTIONS on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_options(self) -> Self

Add a new matcher that can also match MethodMatcher::OPTIONS as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_patch() -> Self

Create a new matcher that matches MethodMatcher::PATCH requests.

See MethodMatcher for more information.

pub fn and_method_patch(self) -> Self

Add a new matcher that also matches MethodMatcher::PATCH on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_patch(self) -> Self

Add a new matcher that can also match MethodMatcher::PATCH as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_post() -> Self

Create a new matcher that matches MethodMatcher::POST requests.

See MethodMatcher for more information.

pub fn and_method_post(self) -> Self

Add a new matcher that also matches MethodMatcher::POST on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_post(self) -> Self

Add a new matcher that can also match MethodMatcher::POST as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_put() -> Self

Create a new matcher that matches MethodMatcher::PUT requests.

See MethodMatcher for more information.

pub fn and_method_put(self) -> Self

Add a new matcher that also matches MethodMatcher::PUT on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_put(self) -> Self

Add a new matcher that can also match MethodMatcher::PUT as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn method_trace() -> Self

Create a new matcher that matches MethodMatcher::TRACE requests.

See MethodMatcher for more information.

pub fn and_method_trace(self) -> Self

Add a new matcher that also matches MethodMatcher::TRACE on top of the existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn or_method_trace(self) -> Self

Add a new matcher that can also match MethodMatcher::TRACE as an alternative tothe existing HttpMatcher matchers.

See MethodMatcher for more information.

pub fn domain(domain: Domain) -> Self

Create a DomainMatcher matcher, matching on the exact given Domain.

pub fn subdomain(domain: Domain) -> Self

Create a DomainMatcher matcher, matching on the exact given Domain or a subdomain of it.

pub fn and_domain(self, domain: Domain) -> Self

Create a DomainMatcher matcher to also match on top of the existing set of HttpMatcher matchers.

See Self::domain for more information.

pub fn and_subdomain(self, domain: Domain) -> Self

Create a sub DomainMatcher matcher to also match on top of the existing set of HttpMatcher matchers.

See Self::subdomain for more information.

pub fn or_domain(self, domain: Domain) -> Self

Create a DomainMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

See Self::domain for more information.

pub fn or_subdomain(self, domain: Domain) -> Self

Create a sub DomainMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

See Self::subdomain for more information.

pub fn version(version: VersionMatcher) -> Self

Create a VersionMatcher matcher.

pub fn and_version(self, version: VersionMatcher) -> Self

Add a VersionMatcher matcher to matcher on top of the existing set of HttpMatcher matchers.

See VersionMatcher for more information.

pub fn or_version(self, version: VersionMatcher) -> Self

Create a VersionMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

See VersionMatcher for more information.

pub fn uri(re: impl AsRef<str>) -> Self

Create a UriMatcher matcher.

pub fn and_uri(self, re: impl AsRef<str>) -> Self

Create a UriMatcher matcher to match on top of the existing set of HttpMatcher matchers.

See UriMatcher for more information.

pub fn or_uri(self, re: impl AsRef<str>) -> Self

Create a UriMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

See UriMatcher for more information.

pub fn path(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher.

pub fn and_path(self, path: impl AsRef<str>) -> Self

Add a PathMatcher to match on top of the existing set of HttpMatcher matchers.

See PathMatcher for more information.

pub fn or_path(self, path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

See PathMatcher for more information.

pub fn header(name: HeaderName, value: HeaderValue) -> Self

Create a HeaderMatcher matcher.

pub fn and_header(self, name: HeaderName, value: HeaderValue) -> Self

Add a HeaderMatcher to match on top of the existing set of HttpMatcher matchers.

See HeaderMatcher for more information.

pub fn or_header(self, name: HeaderName, value: HeaderValue) -> Self

Create a HeaderMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

See HeaderMatcher for more information.

pub fn header_exists(name: HeaderName) -> Self

Create a HeaderMatcher matcher when the given header exists to match on the existence of a header.

pub fn and_header_exists(self, name: HeaderName) -> Self

Add a HeaderMatcher to match when the given header exists on top of the existing set of HttpMatcher matchers.

See HeaderMatcher for more information.

pub fn or_header_exists(self, name: HeaderName) -> Self

Create a HeaderMatcher matcher to match when the given header exists as an alternative to the existing set of HttpMatcher matchers.

See HeaderMatcher for more information.

pub fn header_contains(name: HeaderName, value: HeaderValue) -> Self

Create a HeaderMatcher matcher to match on it containing the given value.

pub fn and_header_contains(self, name: HeaderName, value: HeaderValue) -> Self

Add a HeaderMatcher to match when it contains the given value on top of the existing set of HttpMatcher matchers.

See HeaderMatcher for more information.

pub fn or_header_contains(self, name: HeaderName, value: HeaderValue) -> Self

Create a HeaderMatcher matcher to match if it contains the given value as an alternative to the existing set of HttpMatcher matchers.

See HeaderMatcher for more information.

pub fn socket(socket: SocketMatcher<State, Request<Body>>) -> Self

Create a SocketMatcher matcher.

pub fn and_socket(self, socket: SocketMatcher<State, Request<Body>>) -> Self

Add a SocketMatcher matcher to match on top of the existing set of HttpMatcher matchers.

See SocketMatcher for more information.

pub fn or_socket(self, socket: SocketMatcher<State, Request<Body>>) -> Self

Create a SocketMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

See SocketMatcher for more information.

pub fn get(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a GET request.

pub fn custom<M>(matcher: M) -> Self

where M: Matcher<State, Request<Body>>,

Create a matcher that matches according to a custom predicate.

See rama_core::matcher::Matcher for more information.

pub fn and_custom<M>(self, matcher: M) -> Self

where M: Matcher<State, Request<Body>>,

Add a custom matcher to match on top of the existing set of HttpMatcher matchers.

See rama_core::matcher::Matcher for more information.

pub fn or_custom<M>(self, matcher: M) -> Self

where M: Matcher<State, Request<Body>>,

Create a custom matcher to match as an alternative to the existing set of HttpMatcher matchers.

See rama_core::matcher::Matcher for more information.

pub fn post(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a POST request.

pub fn put(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a PUT request.

pub fn delete(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a DELETE request.

pub fn patch(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a PATCH request.

pub fn head(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a HEAD request.

pub fn options(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a OPTIONS request.

pub fn trace(path: impl AsRef<str>) -> Self

Create a PathMatcher matcher to match for a TRACE request.

pub fn and(self, matcher: HttpMatcher<State, Body>) -> Self

Add a HttpMatcher to match on top of the existing set of HttpMatcher matchers.

pub fn or(self, matcher: HttpMatcher<State, Body>) -> Self

Create a HttpMatcher matcher to match as an alternative to the existing set of HttpMatcher matchers.

pub fn negate(self) -> Self

Negate the current matcher

Trait Implementations

impl<State, Body> Clone for HttpMatcher<State, Body>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<State, Body> Debug for HttpMatcher<State, Body>

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

Formats the value using the given formatter.

impl<State, Body> Matcher<State, Request<Body>> for HttpMatcher<State, Body>

where State: Clone + Send + Sync + 'static, Body: Send + 'static,

fn matches( &self, ext: Option<&mut Extensions>, ctx: &Context<State>, req: &Request<Body>, ) -> bool

returns true on a match, false otherwise

fn or<M>(self, other: M) -> impl Matcher<State, Request>

where Self: Sized, M: Matcher<State, Request>,

Provide an alternative matcher to match if the current one does not match.

fn and<M>(self, other: M) -> impl Matcher<State, Request>

where Self: Sized, M: Matcher<State, Request>,

Add another condition to match on top of the current one.

fn not(self) -> impl Matcher<State, Request>

where Self: Sized,

Negate the current condition.