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.
Adds the following in the dependencies of your Cargo.toml :
toml
rustemon = "2.0.1"
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 :
rust
rustemon::model
For example, if you want the type Pokemon
located in the group pokemon
, it is located here :
rust
rustemon::model::pokemon::Pokemon
The endpoints follow the same naming rule, for example, if you want to call the evolution chain endpoint from the evolution group :
rust
rustemon::evolution::evolution_chain
For each endpoints, 4 functions are defined :
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
bash
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