Struct pavex::request::path::PathParams

source ·
pub struct PathParams<T>(pub T);
Expand description

Extract (typed) path parameters from the path of an incoming request.

§Guide

Check out the guide for more information on how to use this extractor.

§Example

use pavex::f;
use pavex::blueprint::{router::GET, Blueprint, constructor::Lifecycle};
use pavex::request::path::PathParams;

fn blueprint() -> Blueprint {
    let mut bp = Blueprint::new();
    // Register the default constructor and error handler for `PathParams`.
    PathParams::register(&mut bp);
    // Register a route with a path parameter, `:home_id`.
    bp.route(GET, "/home/:home_id", f!(crate::get_home));
    bp
}

// The PathParams attribute macro derives the necessary (de)serialization traits.
#[PathParams]
pub struct Home {
    // The name of the field must match the name of the path parameter
    // used in `bp.route`.
    home_id: u32
}

// The `PathParams` extractor deserializes the extracted path parameters into
// the type you specified—`HomePathParams` in this case.
pub fn get_home(params: &PathParams<Home>) -> String {
   format!("The identifier for this home is: {}", params.0.home_id)
}

home_id will be set to 1 for an incoming /home/1 request.
Extraction will fail, instead, if we receive an /home/abc request.

Tuple Fields§

§0: T

The extracted path parameters, deserialized into T, the type you specified.

Implementations§

source§

impl<T> PathParams<T>

source

pub fn extract<'server, 'request>( params: RawPathParams<'server, 'request>, ) -> Result<Self, ExtractPathParamsError>
where T: Deserialize<'request>, 'server: 'request,

The default constructor for PathParams.

If the extraction fails, an ExtractPathParamsError is returned.

source§

impl PathParams<()>

Auto Trait Implementations§

§

impl<T> Freeze for PathParams<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for PathParams<T>
where T: RefUnwindSafe,

§

impl<T> Send for PathParams<T>
where T: Send,

§

impl<T> Sync for PathParams<T>
where T: Sync,

§

impl<T> Unpin for PathParams<T>
where T: Unpin,

§

impl<T> UnwindSafe for PathParams<T>
where T: 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<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.

§

impl<T> Instrument for T

§

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

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

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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