Struct CallPath

Source
pub struct CallPath { /* private fields */ }
Expand description

A parameterized HTTP path with type-safe parameter substitution.

CallPath represents an HTTP path template with named parameters that can be substituted with typed values. It supports OpenAPI 3.1 parameter styles and automatic schema generation.

§Examples

use clawspec_core::{CallPath, ParamValue};

// Create a path template with method chaining
let path = CallPath::from("/users/{user_id}/posts/{post_id}")
    .add_param("user_id", ParamValue::new(123))
    .add_param("post_id", ParamValue::new("my-post"));

// Path is now ready for resolution to: /users/123/posts/my-post

§Path Template Syntax

Path templates use {parameter_name} syntax for parameter placeholders. Parameter names must be valid identifiers (alphanumeric + underscore). The same parameter can appear multiple times in a single path.

let path = CallPath::from("/api/v1/users/{user_id}/documents/{doc_id}")
    .add_param("user_id", ParamValue::new(456))
    .add_param("doc_id", ParamValue::new("report-2023"));

// Duplicate parameters are supported
let path = CallPath::from("/test/{id}/{id}")
    .add_param("id", ParamValue::new(123));
// Results in: /test/123/123

Implementations§

Source§

impl CallPath

Source

pub fn add_param<T: ParameterValue>( self, name: impl Into<String>, param: impl Into<ParamValue<T>>, ) -> Self

Adds a path parameter with the given name and value.

This method accepts any value that can be converted into a ParamValue<T>, allowing for ergonomic usage where you can pass values directly or use explicit ParamValue wrappers for custom styles.

§Parameters
  • name: The parameter name (will be converted to String)
  • param: The parameter value that can be converted into ParamValue<T>
§Examples
use clawspec_core::{CallPath, ParamValue, ParamStyle};

// Ergonomic usage - pass values directly with method chaining
let path = CallPath::from("/users/{id}")
    .add_param("id", 123);

// Explicit ParamValue usage for custom styles
let path = CallPath::from("/users/{id}")
    .add_param("id", ParamValue::with_style(456, ParamStyle::Simple));

Trait Implementations§

Source§

impl Clone for CallPath

Source§

fn clone(&self) -> CallPath

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CallPath

Source§

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

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

impl Default for CallPath

Source§

fn default() -> CallPath

Returns the “default value” for a type. Read more
Source§

impl Display for CallPath

Source§

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

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

impl From<&str> for CallPath

Source§

fn from(value: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for CallPath

Source§

fn from(value: String) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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

impl<T> ErasedDestructor for T
where T: 'static,