Struct RawPathParams

pub struct RawPathParams<'server, 'request>(/* private fields */);

Extract (raw) path parameters from the URL 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};
use pavex::request::path::RawPathParams;

fn blueprint() -> Blueprint {
    let mut bp = Blueprint::new();
    // [...]
    // Register a route with a few path parameters.
    bp.route(GET, "/address/:address_id/home/:home_id", f!(crate::get_home));
    bp
}

pub fn get_home(params: &RawPathParams) -> String {
    let home_id = &params.get("home_id").unwrap();
    let street_id = &params.get("street_id").unwrap();
    format!("The home with id {} is in street {}", home_id, street_id)
}

Implementations

impl<'server, 'request> RawPathParams<'server, 'request>

pub fn len(&self) -> usize

Returns the number of extracted path parameters.

pub fn get(&self, key: impl AsRef<str>) -> Option<&'request str>

Returns the value of the first path parameter registered under the given key.

pub fn iter(&self) -> RawPathParamsIter<'_, 'server, 'request>

Returns an iterator over the parameters in the list.

pub fn is_empty(&self) -> bool

Returns true if no path parameters have been extracted from the request’s path.

Trait Implementations

impl<'server, 'request> Clone for RawPathParams<'server, 'request>

fn clone(&self) -> RawPathParams<'server, 'request>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'server, 'request> Debug for RawPathParams<'server, 'request>

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

Formats the value using the given formatter.

impl Default for RawPathParams<'_, '_>

fn default() -> Self

Returns the “default value” for a type.

impl<'k, 'v> From<Params<'k, 'v>> for RawPathParams<'k, 'v>

fn from(value: Params<'k, 'v>) -> Self

Converts to this type from the input type.

impl<'server, 'request> PartialEq for RawPathParams<'server, 'request>

fn eq(&self, other: &RawPathParams<'server, 'request>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'server, 'request> Eq for RawPathParams<'server, 'request>

impl<'server, 'request> StructuralPartialEq for RawPathParams<'server, 'request>