Struct ParamValue

pub struct ParamValue<T>
where
    T: Serialize + ToSchema + Debug + Send + Sync + Clone,
{
    pub value: T,
    pub style: ParamStyle,
}

A parameter value with its serialization style

Fields

value: T

The parameter value

style: ParamStyle

The serialization style

Implementations

impl<T> ParamValue<T>

where T: Serialize + ToSchema + Debug + Send + Sync + Clone,

pub fn new(value: T) -> Self

Create a new parameter value with default style

pub fn with_style(value: T, style: ParamStyle) -> Self

Create a new parameter value with specified style

pub fn query_style(&self) -> ParamStyle

Get the actual style to use for query parameters

pub fn path_style(&self) -> ParamStyle

Get the actual style to use for path parameters

pub fn header_style(&self) -> ParamStyle

Get the actual style to use for header parameters

pub fn as_query_value(&self) -> Option<Value>

Converts the parameter to a JSON value for query string serialization.

Returns None if the parameter should not be included in the query string.

pub fn as_header_value(&self) -> Result<Value, ApiClientError>

Converts the parameter to a JSON value for header serialization.

Trait Implementations

impl<T> Clone for ParamValue<T>

where T: Serialize + ToSchema + Debug + Send + Sync + Clone + Clone,

fn clone(&self) -> ParamValue<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ParamValue<T>

where T: Serialize + ToSchema + Debug + Send + Sync + Clone + Debug,

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

Formats the value using the given formatter.

impl<T> From<T> for ParamValue<T>

where T: Serialize + ToSchema + Debug + Send + Sync + Clone,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> PartialSchema for ParamValue<T>

where T: Serialize + ToSchema + Debug + Send + Sync + Clone,

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl<T> ToSchema for ParamValue<T>

where T: Serialize + ToSchema + Debug + Send + Sync + Clone,

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.