Struct RequestParams 

pub struct RequestParams {
    pub fields: Option<Vec<String>>,
    pub filters: Option<Vec<Filter>>,
    pub limit: Option<u32>,
}

Request parameters for API endpoints that support filtering, field selection, and limits.

This struct provides a builder pattern for constructing API requests. All fields are optional and will only be serialized if set.

Builder Pattern

use wme_models::RequestParams;

let params = RequestParams::new()
    .field("name")
    .field("url")
    .filter("in_language.identifier", "en")
    .limit(5);

Fields

fields: Option<Vec<String>>

Fields to include in the response (dot notation)

filters: Option<Vec<Filter>>

Filters to apply to narrow down results

limit: Option<u32>

Maximum number of results to return (default: 3, max: 10, On-demand API only)

Implementations

impl RequestParams

pub fn new() -> RequestParams

Create a new empty request parameters builder.

Example

use wme_models::RequestParams;

let params = RequestParams::new();

pub fn field(self, field: impl Into<String>) -> RequestParams

Add a field to include in the response.

Example

use wme_models::RequestParams;

let params = RequestParams::new()
    .field("name")
    .field("url");

pub fn fields( self, fields: impl IntoIterator<Item = impl Into<String>>, ) -> RequestParams

Add multiple fields to include in the response.

Example

use wme_models::RequestParams;

let params = RequestParams::new()
    .fields(vec!["name", "url", "identifier"]);

pub fn filter( self, field: impl Into<String>, value: impl Into<FilterValue>, ) -> RequestParams

Add a filter to narrow down results.

Example

use wme_models::RequestParams;

let params = RequestParams::new()
    .filter("in_language.identifier", "en")
    .filter("is_part_of.identifier", "enwiki");

pub fn limit(self, limit: u32) -> RequestParams

Set the limit for number of results (On-demand API only, max 10).

Values above 10 will be clamped to 10.

Example

use wme_models::RequestParams;

let params = RequestParams::new().limit(5);

Trait Implementations

impl Clone for RequestParams

fn clone(&self) -> RequestParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestParams

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

Formats the value using the given formatter.

impl Default for RequestParams

fn default() -> RequestParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RequestParams

fn deserialize<__D>( __deserializer: __D, ) -> Result<RequestParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RequestParams

fn eq(&self, other: &RequestParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RequestParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RequestParams