Struct Params 

pub struct Params<'k, 'v> { /* private fields */ }

Matcher parameters.

This is a thin wrapper around the Params data type of the matchit crate to shield against unforeseen changes in the crate’s implementation.

Note that Params should be used without lifetime parameters, as it’s designed to be used in a context where lifetimes are irrelevant, i.e., in the signature of an Action, ensuring that third-party integrations don’t break when the implementation changes, albeit unlikely.

Implementations

impl<'k, 'v> Params<'k, 'v>

pub fn get<K>(&self, key: K) -> Option<&'v str>

where K: AsRef<str>,

Returns the value for the given key.

Examples

use zapient::http::{Request, Response, Status};
use zapient::router::{Router, Params};

// Create router and add route
let router = Router::default()
    .get("/coffee/{kind}", |req: Request, params: Params| {
        if let Some(kind) = params.get("kind") {
            Response::default() // Handle request
        } else {
            Response::new().status(Status::BadRequest)
        }
    });

pub fn contains<K>(&self, key: K) -> bool

where K: AsRef<str>,

Returns whether the parameter is contained.

Examples

use zapient::http::{Request, Response, Status};
use zapient::router::{Router, Params};

// Create router and add route
let router = Router::default()
    .get("/coffee/{kind}", |req: Request, params: Params| {
        if params.contains("kind") {
            Response::default() // Handle request
        } else {
            Response::new().status(Status::BadRequest)
        }
    });

pub fn iter(&self) -> ParamsIter<'_, 'k, 'v>

Returns an iterator over all parameters.

Examples

use zapient::http::{Request, Response};
use zapient::router::{Router, Params};

// Create router and add route
let router = Router::default()
    .get("/coffee/{kind}", |req: Request, params: Params| {
        for (key, value) in params.iter() {
            println!("{key}: {value}");
        }
        Response::default() // Handle request
    });

impl Params<'_, '_>

pub fn len(&self) -> usize

Returns the number of parameters.

pub fn is_empty(&self) -> bool

Returns whether the parameter map is empty.

Trait Implementations

impl<'k, 'v> Clone for Params<'k, 'v>

fn clone(&self) -> Params<'k, 'v>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'k, 'v> Debug for Params<'k, 'v>

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

Formats the value using the given formatter.

impl<'a, 'k, 'v> IntoIterator for &'a Params<'k, 'v>

fn into_iter(self) -> Self::IntoIter

Creates an iterator over all parameters.

Examples

use zapient::http::{Request, Response};
use zapient::router::{Router, Params};

// Create router and add route
let router = Router::default()
    .get("/coffee/{kind}", |req: Request, params: Params| {
        for (key, value) in &params {
            println!("{key}: {value}");
        }
        Response::default() // Handle request
    });

type Item = (&'k str, &'v str)

The type of the elements being iterated over.

type IntoIter = ParamsIter<'a, 'k, 'v>

Which kind of iterator are we turning this into?