pub struct Path<P> { /* private fields */ }Expand description
A predicate that matches request paths against a pattern.
Uses actix-router for pattern matching.
The predicate returns Cacheable when the
request path matches the pattern.
§Type Parameters
P- The inner predicate to chain with. UsePath::newto start a new predicate chain (usesNeutralinternally), or use thePathPredicateextension trait to chain onto an existing predicate.
§Pattern Syntax
{name}— matches a path segment{name:regex}— matches with regex constraint{tail}*— matches remaining path segments
§Examples
use hitbox_http::predicates::request::{Path, PathPredicate};
use actix_router::ResourceDef;
// Match requests to /api/users/{id}
let predicate = Path::new(ResourceDef::new("/api/users/{id}"));Implementations§
Source§impl<S> Path<Neutral<S>>
impl<S> Path<Neutral<S>>
Sourcepub fn new(resource: ResourceDef) -> Self
pub fn new(resource: ResourceDef) -> Self
Creates a predicate that matches request paths against a pattern.
Returns Cacheable when
the request path matches the pattern, NonCacheable otherwise.
Chain onto existing predicates using PathPredicate::path instead
if you already have a predicate chain.
Trait Implementations§
Auto Trait Implementations§
impl<P> Freeze for Path<P>where
P: Freeze,
impl<P> RefUnwindSafe for Path<P>where
P: RefUnwindSafe,
impl<P> Send for Path<P>where
P: Send,
impl<P> Sync for Path<P>where
P: Sync,
impl<P> Unpin for Path<P>where
P: Unpin,
impl<P> UnwindSafe for Path<P>where
P: UnwindSafe,
Blanket Implementations§
Source§impl<P> BodyPredicate for Pwhere
P: Predicate,
impl<P> BodyPredicate for Pwhere
P: Predicate,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<P> HeaderPredicate for Pwhere
P: Predicate,
impl<P> HeaderPredicate for Pwhere
P: Predicate,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<P> MethodPredicate for Pwhere
P: Predicate,
impl<P> MethodPredicate for Pwhere
P: Predicate,
Source§impl<P> PathPredicate for Pwhere
P: Predicate,
impl<P> PathPredicate for Pwhere
P: Predicate,
Source§impl<T> PredicateExt for Twhere
T: Predicate,
impl<T> PredicateExt for Twhere
T: Predicate,
Source§impl<P> QueryPredicate for Pwhere
P: Predicate,
impl<P> QueryPredicate for Pwhere
P: Predicate,
Source§impl<P> StatusCodePredicate for Pwhere
P: Predicate,
impl<P> StatusCodePredicate for Pwhere
P: Predicate,
Source§fn status_code(self, status_code: StatusCode) -> StatusCode<P>
fn status_code(self, status_code: StatusCode) -> StatusCode<P>
Matches an exact status code.
Source§fn status_code_in(self, codes: Vec<StatusCode>) -> StatusCode<P>
fn status_code_in(self, codes: Vec<StatusCode>) -> StatusCode<P>
Matches any of the specified status codes.
Source§fn status_code_range(self, start: StatusCode, end: StatusCode) -> StatusCode<P>
fn status_code_range(self, start: StatusCode, end: StatusCode) -> StatusCode<P>
Matches status codes within a range (inclusive).
Source§fn status_code_class(self, class: StatusClass) -> StatusCode<P>
fn status_code_class(self, class: StatusClass) -> StatusCode<P>
Matches all status codes in a class (e.g., all 2xx).
Source§impl<P> VersionPredicate for Pwhere
P: Predicate,
impl<P> VersionPredicate for Pwhere
P: Predicate,
Source§fn version(self, operation: Operation) -> HttpVersion<P>
fn version(self, operation: Operation) -> HttpVersion<P>
Adds a version match to this predicate chain.