13 stable releases (3 major)
|3.2.1||Aug 21, 2023|
|3.2.0||May 27, 2023|
|3.1.0||Jan 19, 2023|
|3.0.1||Nov 25, 2022|
|0.1.1||Nov 29, 2021|
#2 in #pokemon
166 downloads per month
This library is a wrapper for the awesome PokeApi, which provides all the informations you need about Pokémons !
Fully written in Rust, this library covers the whole PokeApi REST api v2.
How to import it ?
Adds the following in the dependencies of your Cargo.toml :
rustemon = "3.2.1"
How to use it ?
As you noticed in the documentation of PokeApi, every endpoints and models are declared in groups.
The library kept this group oriented architecture !
All the models are located into the following module :
For example, if you want the type
Pokemon located in the group
pokemon, it is located here :
The endpoints follow the same naming rule, for example, if you want to call the evolution chain endpoint from the evolution group :
For each endpoints, 4 functions are defined :
- get_page : without parameters, calls the endpoint without any informations to retrieve the first page of the paginated response for the endpoint, as defined here,
- get_page_with_param : allows you to modify the parameters for the paginated query,
- get_by_id : calls the endpoint using the id of the targeted resource,
- get_by_name : calls the endpoint using the name of the targeted resource.
By default, the endpoints are all async ! Which means you NEED to add a async runtime (such as tokio for example), in order for the library to work.
All calls to the API are cached by a middleware attached to the RustemonClient you need to instanciate in order to make calls to the PokeAPI.
Examples and use cases are available in the
examples folder. For instance, you can run the
async_follow example using
cargo run --example async_follow
The license of the library can be found here.
If you find any bug or improvement that you find valuable, please fill an issue right there -> project issues