Crate arnak

source ·
Expand description

§arnak

A Rust library for the Board Game Geek XML API.

§Example:

use arnak::BoardGameGeekApi;

// Enter tokio async runtime.
let rt = tokio::runtime::Runtime::new().unwrap();
rt.block_on(async {
    let api = BoardGameGeekApi::new();
    let collection = api.collection().get_owned("bluebearbgg").await;

    match collection {
        Ok(collection) => println!("bluebearbgg owns {} games.", collection.items.len()),
        Err(e) => println!("Error: {e}"),
    }
})

Structs§

  • BaseCollectionQuery
    Required query paramters. Any type the collection query can implement must be able to return a base query, so valid queries can be constructed for both CollectionItem and CollectionItemBrief.
  • BaseSearchQuery
    Required query paramters.
  • BoardGameGeekApi
    API for making requests to the Board Game Geek API.
  • Collection
    A user’s collection on boardgamegeek.
  • CollectionApi
    Collection endpoint of the API. Used for returning user’s collections of games by their username. Filtering by CollectionItemStatus, rating, recorded plays.
  • CollectionItem
    A game or game expansion in a collection.
  • CollectionItemBrief
    An item in a collection, in brief form. With only the name, status, type, and IDs.
  • CollectionItemRating
    The 0-10 rating that the user gave to this game. Also includes the total number of users that have rated it, as well as the averages, and standard deviation.
  • CollectionItemRatingBrief
    The 0-10 rating that the user gave to this game. Also includes the total number of users that have rated it, as well as the averages.
  • CollectionItemStats
    Stats of the game such as playercount and duration. Can be omitted from the response. More stats can be found from the specific game endpoint.
  • CollectionItemStatsBrief
    Stats of the game such as playercount and duration. Can be omitted from the response. More stats can be found from the specific game endpoint.
  • CollectionItemStatus
    The status of the game in the user’s collection, such as preowned or wishlist. Can be any or none of them.
  • CollectionQueryParams
    All optional query parameters for making a request to the collection endpoint.
  • GameTypeRank
    A struct containing the game’s rank within a particular type of game.
  • HotItem
  • HotList
    The returned struct containing a list of hot board games.
  • HotListApi
    Hot list endpoint of the API. Used for returning the current trending board games.
  • SearchApi
    Search endpoint of the API. Used for searching for games by name.
  • SearchQueryParams
    All optional query parameters for making a request to the search endpoint.
  • SearchResult
    A result when searching for a name. Includes the game’s name, type, and year published.
  • SearchResults
    The returned struct containing a list of search results.

Enums§

  • Error
    An error returned by the API. This is an enum representing either an http error (reqwest::Error), or an error parsing the output (serde_xml_rs::Error), or finally just a string. Which is typically returned in some case an error shouldn’t happen.
  • GameType
    The type of game, board game or expansion.
  • RankValue
    A rank a particular board game has on the site, within a subtype. Can be either Ranked with a u64 for the rank, Or NotRanked.
  • WishlistPriority
    The status of the game in the user’s collection, such as preowned or wishlist. Can be any or none of them.

Traits§

Type Aliases§

  • Result
    A Result alias where the Err case is arnak::Error.