rustemon 3.2.1

Library wrapping the awesome PokeAPI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Locations group models

use super::{
    encounters::EncounterMethod,
    games::{Generation, Pokedex, Version, VersionGroup},
    pokemon::{Pokemon, PokemonSpecies},
    resource::{GenerationGameIndex, Name, NamedApiResource, VersionEncounterDetail},
};

/// [Location official documentation](https://pokeapi.co/docs/v2#location)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Location {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The region this location can be found in.
    pub region: Option<NamedApiResource<Region>>,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
    /// A list of game indices relevent to this location by generation.
    pub game_indices: Vec<GenerationGameIndex>,
    /// Areas that can be found within this location.
    pub areas: Vec<NamedApiResource<LocationArea>>,
}

/// [LocationArea official documentation](https://pokeapi.co/docs/v2#locationarea)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct LocationArea {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The internal id of an API resource within game data.
    pub game_index: i64,
    /// A list of methods in which Pokémon may be encountered in this area
    /// and how likely the method will occur depending on the version of the game.
    pub encounter_method_rates: Vec<EncounterMethodRate>,
    /// The region this location area can be found in.
    pub location: NamedApiResource<Location>,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
    /// A list of Pokémon that can be encountered in this area
    /// along with version specific details about the encounter.
    pub pokemon_encounters: Vec<PokemonEncounter>,
}

/// [EncounterMethodRate official documentation](https://pokeapi.co/docs/v2#encountermethodrate)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct EncounterMethodRate {
    /// The method in which Pokémon may be encountered in an area.
    pub encounter_method: NamedApiResource<EncounterMethod>,
    /// The chance of the encounter to occur on a version of the game.
    pub version_details: Vec<EncounterVersionDetails>,
}

/// [EncounterVersionDetails official documentation](https://pokeapi.co/docs/v2#encounterversiondetails)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct EncounterVersionDetails {
    /// The chance of an encounter to occur.
    pub rate: i64,
    /// The version of the game in which the encounter can occur with the given chance.
    pub version: NamedApiResource<Version>,
}

/// [PokemonEncounter official documentation](https://pokeapi.co/docs/v2#pokemonencounter)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct PokemonEncounter {
    /// The Pokémon being encountered.
    pub pokemon: NamedApiResource<Pokemon>,
    /// A list of versions and encounters with Pokémon that might happen in the referenced location area.
    pub version_details: Vec<VersionEncounterDetail>,
}

/// [PalParkArea official documentation](https://pokeapi.co/docs/v2#palparkarea)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct PalParkArea {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
    /// A list of Pokémon encountered in thi pal park area along with details.
    pub pokemon_encounters: Vec<PalParkEncounterSpecies>,
}

/// [PalParkEncounterSpecies official documentation](https://pokeapi.co/docs/v2#palparkencounterspecies)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct PalParkEncounterSpecies {
    /// The base score given to the player when this Pokémon is caught during a pal park run.
    pub base_score: i64,
    /// The base rate for encountering this Pokémon in this pal park area.
    pub rate: i64,
    /// The Pokémon species being encountered.
    pub pokemon_species: NamedApiResource<PokemonSpecies>,
}

/// [Region official documentation](https://pokeapi.co/docs/v2#region)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Region {
    /// The identifier for this resource.
    pub id: i64,
    /// A list of locations that can be found in this region.
    pub locations: Vec<NamedApiResource<Location>>,
    /// The name for this resource.
    pub name: String,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
    /// The generation this region was introduced in.
    pub main_generation: Option<NamedApiResource<Generation>>,
    /// A list of pokédexes that catalogue Pokémon in this region.
    pub pokedexes: Vec<NamedApiResource<Pokedex>>,
    /// A list of version groups where this region can be visited.
    pub version_groups: Vec<NamedApiResource<VersionGroup>>,
}