Struct arnak::CollectionQueryParams

pub struct CollectionQueryParams { /* private fields */ }

All optional query parameters for making a request to the collection endpoint.

By default if all status options are excluded then they are all returned. If any are set to true then any excluded will not be returned.

Implementations

impl CollectionQueryParams

pub fn new() -> Self

Constructs a collection query with parameters set to None.

pub fn item_type(self, item_type: GameType) -> Self

Sets the item_type field, so that only that type of item will be returned.

pub fn exclude_item_type(self, exclude_item_type: GameType) -> Self

Set the exclude_item_type field, so that that type of item will be excluded from. the results.

pub fn include_owned(self, include_owned: bool) -> Self

Sets the include_owned field. If true the result will include items that the user owns. Unless all status fields are kept at None, then they are all included.

pub fn include_previously_owned(self, include_previously_owned: bool) -> Self

Sets the include_previously_owned field. If true the result will include items that the user owns. Unless all status fields are kept at None, then they are all included.

pub fn include_for_trade(self, include_for_trade: bool) -> Self

Sets the include_for_trade field. If true the result will include items that the user wants to trade away. Unless all status fields are kept at None, then they are all included.

pub fn include_want_in_trade(self, include_want_in_trade: bool) -> Self

Sets the include_want_in_trade field. If true the result will include items that the user wants to receive in a trade. Unless all status fields are kept at None, then they are all included.

pub fn include_want_to_play(self, include_want_to_play: bool) -> Self

Sets the include_want_to_play field. If true the result will include items that the user wants to play. Unless all status fields are kept at None, then they are all included.

pub fn include_want_to_buy(self, include_want_to_buy: bool) -> Self

Sets the include_want_to_buy field. If true the result will include items that the user wants to buy. Unless all status fields are kept at None, then they are all included.

pub fn include_preordered(self, include_preordered: bool) -> Self

Sets the include_preordered field. If true the result will include items that the user wants to buy. Unless all status fields are kept at None, then they are all included.

pub fn include_wishlist(self, include_wishlist: bool) -> Self

Sets the include_wishlist field. If true the result will include the items that the user has on their wishlist. Unless all status fields are kept at None, then they are all included.

pub fn wishlist_priority(self, wishlist_priority: WishlistPriority) -> Self

Sets the wishlist_priority field. If set then only results with that wishlist priority will be returned.

pub fn modified_since(self, modified_since: NaiveDate) -> Self

Sets the modified_since field. If set then only results that have been modified since that datetime will be returned.

pub fn include_stats(self, include_stats: bool) -> Self

Sets the include_stats field. If false the stats are omitted. Since the default behaviour is inconsistent. Keeping this at None will be treated as true at build time.

pub fn include_rated_by_user(self, include_rated_by_user: bool) -> Self

Sets the include_rated_by_user field. If set then only results that the user has rated will be returned.

pub fn include_played_by_user(self, include_played_by_user: bool) -> Self

Sets the include_played_by_user field. If set then only results that the user has marked as having played will be returned.

pub fn include_commented(self, include_commented: bool) -> Self

Sets the include_commented field. If set then only results that the user has commented on will be returned.

pub fn has_parts(self, has_parts: bool) -> Self

Sets the has_parts field. If set then only results that the user has commented on the Has Parts field.

pub fn want_parts(self, want_parts: bool) -> Self

Sets the want_parts field. If set then only results that the user has commented on the Want Parts field.

pub fn min_rating(self, min_rating: f32) -> Self

Sets the min_rating field. If set then only results that the user has rated equal or greater than that value will be returned.

pub fn max_rating(self, max_rating: f32) -> Self

Sets the max_rating field. If set then only results that the user has rated equal or less than that value will be returned.

pub fn min_bgg_rating(self, min_bgg_rating: f32) -> Self

Sets the min_bgg_rating field. If set then only results that have a “Geek rating” equal or greater than that value will be returned.

pub fn max_bgg_rating(self, max_bgg_rating: f32) -> Self

Sets the max_bgg_rating field. If set then only results that have a “Geek rating” equal or less than that value will be returned.

pub fn min_plays(self, min_plays: u64) -> Self

Sets the max_plays field. If set then only results that have this many recorded plays by the user or more will be returned.

pub fn max_plays(self, max_plays: u64) -> Self

Sets the max_plays field. If set then only results that have this many recorded plays by the user or less will be returned.

pub fn show_private(self, show_private: bool) -> Self

Sets the show_private field. If set then private information about the collection will be returned. Only works if the user is logged in and requesting their own collection.

pub fn collection_id(self, collection_id: u64) -> Self

Sets the collection_id field. If set then results will be filtered to get the item with the specific collection ID.

Trait Implementations

impl Clone for CollectionQueryParams

fn clone(&self) -> CollectionQueryParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionQueryParams

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

Formats the value using the given formatter.

impl Default for CollectionQueryParams

fn default() -> CollectionQueryParams

Returns the “default value” for a type.