Skip to main content

Path

Struct Path 

Source
pub struct Path<E> { /* private fields */ }
Expand description

Extracts path parameters as cache key parts.

Uses actix-router patterns to match and extract named segments from the request path.

§Type Parameters

  • E - The inner extractor to chain with. Use Path::new to start a new extractor chain (uses NeutralExtractor internally), or use the PathExtractor extension trait to chain onto an existing extractor.

§Pattern Syntax

  • {name} — captures a path segment (characters until /)
  • {name:regex} — captures with regex constraint (e.g., {id:\d+})
  • {tail}* — captures remaining path (e.g., /blob/{path}* matches /blob/a/b/c)

§Examples

use hitbox_http::extractors::Path;

// Extract user_id and post_id from "/users/42/posts/123"
let extractor = Path::new("/users/{user_id}/posts/{post_id}");

Using the builder pattern:

use hitbox_http::extractors::{Method, path::PathExtractor};

let extractor = Method::new()
    .path("/api/v1/users/{user_id}");

§Key Parts Generated

For path /users/42/posts/123 with pattern /users/{user_id}/posts/{post_id}:

  • KeyPart { key: "user_id", value: Some("42") }
  • KeyPart { key: "post_id", value: Some("123") }

§Format Examples

Request PathPatternGenerated Key Parts
/users/42/users/{id}id=42
/api/v2/items/api/{version}/itemsversion=v2
/files/docs/report.pdf/files/{path}*path=docs/report.pdf
/orders/123/items/456/orders/{order_id}/items/{item_id}order_id=123&item_id=456

Implementations§

Source§

impl<S> Path<NeutralExtractor<S>>

Source

pub fn new(resource: &str) -> Self

Creates a path extractor that captures named segments from request paths.

Each captured segment becomes a cache key part with the segment name as key. See the struct documentation for pattern syntax.

Chain onto existing extractors using PathExtractor::path instead if you already have an extractor chain.

Trait Implementations§

Source§

impl<E: Debug> Debug for Path<E>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<ReqBody, E> Extractor for Path<E>
where ReqBody: Body + Send + 'static, ReqBody::Error: Send, E: Extractor<Subject = CacheableHttpRequest<ReqBody>> + Send + Sync,

Source§

type Subject = <E as Extractor>::Subject

The type from which cache key components are extracted.
Source§

fn get<'life0, 'async_trait>( &'life0 self, subject: Self::Subject, ) -> Pin<Box<dyn Future<Output = KeyParts<Self::Subject>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Extract cache key components from the subject. Read more

Auto Trait Implementations§

§

impl<E> Freeze for Path<E>
where E: Freeze,

§

impl<E> RefUnwindSafe for Path<E>
where E: RefUnwindSafe,

§

impl<E> Send for Path<E>
where E: Send,

§

impl<E> Sync for Path<E>
where E: Sync,

§

impl<E> Unpin for Path<E>
where E: Unpin,

§

impl<E> UnwindSafe for Path<E>
where E: UnwindSafe,

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<E> BodyExtractor for E
where E: Extractor,

Source§

fn body(self, extraction: BodyExtraction) -> Body<E>

Adds body extraction with the specified mode.
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<E> HeaderExtractor for E
where E: Extractor,

Source§

fn header(self, name: String) -> Header<E>

Adds extraction for a single header by exact name.
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<E> MethodExtractor for E
where E: Extractor,

Source§

fn method(self) -> Method<E>

Adds HTTP method extraction to the chain.
Source§

impl<E> PathExtractor for E
where E: Extractor,

Source§

fn path(self, resource: &str) -> Path<E>

Adds path parameter extraction with the given pattern. Read more
Source§

impl<E> QueryExtractor for E
where E: Extractor,

Source§

fn query(self, name: String) -> Query<E>

Adds extraction for a single query parameter by name.
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<E> VersionExtractor for E
where E: Extractor,

Source§

fn version(self) -> Version<E>

Adds HTTP version extraction to this extractor chain.
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