Struct Param 

pub struct Param {
    pub style: ParamStyle,
    pub name: String,
    pub values: Vec<(Option<String>, Option<String>)>,
    pub required: bool,
}

Describes a parameter (path, query, header, etc.) for an API resource

Fields

style: ParamStyle

The type/location of the parameter

name: String

The name of the parameter (e.g., “q”, “fl”, etc.)

values: Vec<(Option<String>, Option<String>)>

Value(s) of the parameter

required: bool

Whether or not the parameter is required

Implementations

impl Param

pub fn of_type(style: ParamStyle) -> ParamBuilder

Create an instance of Param using the builder syntax

impl Param

pub fn is_body(&self) -> bool

Check if this parameter is a body parameter

pub fn is_query(&self) -> bool

Check if this parameter is a query parameter (either a query pair, boosted query field, or field list)

pub fn is_header(&self) -> bool

Check if this parameter is a header parameter

pub fn is_template(&self) -> bool

Check if this parameter is a template value

pub fn to_query_string<Q: QueryField + ValueValidator, F: QueryField>( params: Vec<Param>, ) -> String

Convert a list of params to a query string

pub fn from_query_pair(key: &str, pairs: Vec<(&str, &str)>) -> Self

Create a query pair parameter with key-value pairs

Example

let param = Param::from_query_pair("q", vec![("given-names", "Jason"), ("family-name", "Wohlgemuth")]);
let rendered = param.to_string::<orcid::SearchField, orcid::OutputColumn>();
let expected = "q=given-names:Jason+AND+family-name:Wohlgemuth";
assert_eq!(rendered, expected);

pub fn from_field_list(key: &str, fields: Vec<&str>) -> Self

Create a field list parameter with a list of field names

pub fn from_query_field(key: &str, fields: Vec<&str>) -> Self

Create a boosted query field parameter with a list of field names

pub fn to_string<Q: QueryField + ValueValidator, F: QueryField>(&self) -> String

Render this parameter to a query string using the provided field types.

• Q is used for query pairs and boosted query fields and must support validation (Validate trait).
• F is used for field lists (e.g., output columns).

Trait Implementations

impl Clone for Param

fn clone(&self) -> Param

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Param

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Param

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Param

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.