Struct CallQuery

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

A collection of query parameters for HTTP requests with OpenAPI 3.1 support.

CallQuery provides a type-safe way to build and serialize query parameters for HTTP requests. It supports different parameter styles as defined by the OpenAPI 3.1 specification and automatically generates OpenAPI parameter schemas.

§Examples

§Basic Usage

use clawspec_core::{CallQuery, ParamValue, ParamStyle};

let query = CallQuery::new()
    .add_param("search", ParamValue::new("hello world"))
    .add_param("limit", ParamValue::new(10))
    .add_param("active", ParamValue::new(true));

// This would generate: ?search=hello+world&limit=10&active=true

§Array Parameters with Different Styles

use clawspec_core::{CallQuery, ParamValue, ParamStyle};
let query = CallQuery::new()
    // Form style (default): ?tags=rust&tags=web&tags=api
    .add_param("tags", ParamValue::new(vec!["rust", "web", "api"]))
    // Space delimited: ?categories=tech%20programming
    .add_param("categories", ParamValue::with_style(
        vec!["tech", "programming"],
        ParamStyle::SpaceDelimited
    ))
    // Pipe delimited: ?ids=1|2|3
    .add_param("ids", ParamValue::with_style(
        vec![1, 2, 3],
        ParamStyle::PipeDelimited
    ));

§Type Safety

The query system is type-safe and will prevent invalid parameter types:

  • Objects are not supported as query parameters (will return an error)
  • All parameters must implement Serialize and ToSchema traits
  • Parameters are automatically converted to appropriate string representations

Implementations§

Source§

impl CallQuery

Source

pub fn new() -> Self

Creates a new empty query parameter collection.

§Examples
use clawspec_core::CallQuery;

let query = CallQuery::new();
// Query is initially empty
Source

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

Adds a query parameter with the given name and value using the builder pattern.

This method consumes self and returns a new CallQuery with the parameter added, allowing for method chaining. The parameter must implement both Serialize and ToSchema traits for proper serialization and OpenAPI schema generation.

§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::{CallQuery, ParamValue, ParamStyle};

// Ergonomic usage - pass values directly
let query = CallQuery::new()
    .add_param("search", "hello")
    .add_param("limit", 10)
    .add_param("active", true);

// Explicit ParamValue usage for custom styles
let query = CallQuery::new()
    .add_param("tags", ParamValue::with_style(
        vec!["rust", "web"],
        ParamStyle::SpaceDelimited
    ));

Trait Implementations§

Source§

impl Clone for CallQuery

Source§

fn clone(&self) -> CallQuery

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 CallQuery

Source§

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

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

impl Default for CallQuery

Source§

fn default() -> CallQuery

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

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, 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,