Struct CommonParams 

pub struct CommonParams {
    pub format: Option<Format>,
    pub attributes: Option<AttributesSelect>,
    pub query: Option<String>,
    pub filter: Option<FacetReq>,
    pub per_page: Option<u32>,
    pub page: Option<u32>,
    pub sort: Option<SortField>,
}

Represents common query parameters applicable to multiple endpoints.

Fields

format: Option<Format>

Specifies the format of the returned results (fo=json or fo=yaml).

attributes: Option<AttributesSelect>

Selects one or more attributes to include or exclude in the response.

query: Option<String>

Conducts a keyword search in the metadata and any available full text (q parameter).

filter: Option<FacetReq>

Applies facet filters to narrow down search results (fa parameter).

per_page: Option<u32>

Sets the number of results per page (c parameter). Default is 25.

page: Option<u32>

Specifies the page number to retrieve (sp parameter). The first page is 1.

sort: Option<SortField>

Defines the sorting order of the results (sb parameter).

Trait Implementations

impl Clone for CommonParams

fn clone(&self) -> CommonParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommonParams

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

Formats the value using the given formatter.

impl Default for CommonParams

fn default() -> CommonParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommonParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CommonParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.