Struct CallPath

pub struct CallPath { /* private fields */ }

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

impl CallPath

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

impl Clone for CallPath

fn clone(&self) -> CallPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallPath

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

Formats the value using the given formatter.

impl Default for CallPath

fn default() -> CallPath

Returns the “default value” for a type.

impl Display for CallPath

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

Formats the value using the given formatter.

impl From<&str> for CallPath

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for CallPath

fn from(value: String) -> Self

Converts to this type from the input type.