steamgriddb_api/lib.rs
1//! # Steamgriddb API
2//!
3//! This project is a wrapper for the steamgriddb api, written in Rust.
4//!
5//! ## Getting started
6//!
7//! The easiest way to get started is using the Client.
8//!
9//! ```no_run
10//! use steamgriddb_api::Client;
11//! use steamgriddb_api::QueryType::Grid;
12//! async fn example() -> Result<(), Box<dyn std::error::Error>> {
13//! let client = Client::new("my_auth_key");
14//! let games = client.search("Celeste").await?;
15//! let first_game = games.iter().next();
16//! if let Some(first_game) = first_game {
17//! assert_eq!("Celeste", first_game.name);
18//! let images = client.get_images_for_id(first_game.id, &Grid(None)).await?;
19//! }
20//! Ok(())
21//! }
22//! ```
23
24
25pub mod client;
26pub mod games;
27pub mod images;
28pub mod query_parameters;
29pub mod response;
30pub mod search;
31pub mod steam_static;
32
33pub use client::Client;
34pub use query_parameters::QueryType;