rustemon 3.0.0

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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

//! Moves group models

use super::{
    contests::{ContestEffect, ContestType, SuperContestEffect},
    games::{Generation, VersionGroup},
    pokemon::{AbilityEffectChange, Pokemon, Stat, Type},
    resource::{
        ApiResource, Description, MachineVersionDetail, Name, NamedApiResource, VerboseEffect,
    },
    utility::Language,
};

/// [Move official documentation](https://pokeapi.co/docs/v2#move)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Move {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The percent value of how likely this move is to be successful.
    pub accuracy: Option<i64>,
    /// The percent value of how likely it is this moves effect will happen.
    pub effect_chance: Option<i64>,
    /// Power points. The number of times this move can be used.
    pub pp: Option<i64>,
    /// A value between -8 and 8. Sets the order in which moves are executed during battle.
    /// See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Priority) for greater detail.
    pub priority: i64,
    /// The base power of this move with a value of 0 if it does not have a base power.
    pub power: Option<i64>,
    /// A detail of normal and super contest combos that require this move.
    pub contest_combos: Option<ContestComboSets>,
    /// The type of appeal this move gives a Pokémon when used in a contest.
    pub contest_type: Option<NamedApiResource<ContestType>>,
    /// The effect the move has when used in a contest.
    pub contest_effect: Option<ApiResource<ContestEffect>>,
    /// The type of damage the move inflicts on the target, e.g. physical.
    pub damage_class: NamedApiResource<MoveDamageClass>,
    /// The effect of this move listed in different languages.
    pub effect_entries: Vec<VerboseEffect>,
    /// The list of previous effects this move has had across version groups of the games.
    pub effect_changes: Vec<AbilityEffectChange>,
    /// List of Pokemon that can learn the move
    pub learned_by_pokemon: Vec<NamedApiResource<Pokemon>>,
    /// The flavor text of this move listed in different languages.
    pub flavor_text_entries: Vec<MoveFlavorText>,
    /// The generation in which this move was introduced.
    pub generation: NamedApiResource<Generation>,
    /// A list of the machines that teach this move.
    pub machines: Vec<MachineVersionDetail>,
    /// Metadata about this move.
    pub meta: Option<MoveMetaData>,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
    /// A list of move resource value changes across version groups of the game.
    pub past_values: Vec<PastMoveStatValues>,
    /// A list of stats this moves effects and how much it effects them.
    pub stat_changes: Vec<MoveStatChange>,
    /// The effect the move has when used in a super contest.
    pub super_contest_effect: Option<ApiResource<SuperContestEffect>>,
    /// The type of target that will receive the effects of the attack.
    pub target: NamedApiResource<MoveTarget>,
    /// The elemental type of this move.
    #[serde(rename = "type")]
    pub type_: NamedApiResource<Type>,
}

/// [ContestComboSets official documentation](https://pokeapi.co/docs/v2#contestcombosets)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ContestComboSets {
    /// A detail of moves this move can be used before or after, granting additional appeal points in contests.
    pub normal: ContestComboDetail,
    /// A detail of moves this move can be used before or after, granting additional appeal points in super contests.
    #[serde(rename = "super")]
    pub super_: ContestComboDetail,
}

/// [ContestComboDetail official documentation](https://pokeapi.co/docs/v2#contestcombodetail)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ContestComboDetail {
    /// A list of moves to use before this move.
    pub use_before: Option<Vec<NamedApiResource<Move>>>,
    /// A list of moves to use after this move.
    pub use_after: Option<Vec<NamedApiResource<Move>>>,
}

/// [MoveFlavorText official documentation](https://pokeapi.co/docs/v2#moveflavortext)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveFlavorText {
    /// The localized flavor text for an api resource in a specific language.
    pub flavor_text: String,
    /// The language this name is in.
    pub language: NamedApiResource<Language>,
    /// The version group that uses this flavor text.
    pub version_group: NamedApiResource<VersionGroup>,
}

/// [MoveMetaData official documentation](https://pokeapi.co/docs/v2#movemetadata)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveMetaData {
    /// The status ailment this move inflicts on its target.
    pub ailment: NamedApiResource<MoveAilment>,
    /// The category of move this move falls under, e.g. damage or ailment.
    pub category: NamedApiResource<MoveCategory>,
    /// The minimum number of times this move hits. Null if it always only hits once.
    pub min_hits: Option<i64>,
    /// The maximum number of times this move hits. Null if it always only hits once.
    pub max_hits: Option<i64>,
    /// The minimum number of turns this move continues to take effect. Null if it always only lasts one turn.
    pub min_turns: Option<i64>,
    /// The maximum number of turns this move continues to take effect. Null if it always only lasts one turn.
    pub max_turns: Option<i64>,
    /// HP drain (if positive) or Recoil damage (if negative), in percent of damage done.
    pub drain: i64,
    /// The amount of hp gained by the attacking Pokemon, in percent of it's maximum HP.
    pub healing: i64,
    /// Critical hit rate bonus.
    pub crit_rate: i64,
    /// The likelihood this attack will cause an ailment.
    pub ailment_chance: i64,
    /// The likelihood this attack will cause the target Pokémon to flinch.
    pub flinch_chance: i64,
    /// The likelihood this attack will cause a stat change in the target Pokémon.
    pub stat_chance: i64,
}

/// [MoveStatChange official documentation](https://pokeapi.co/docs/v2#movestatchange)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveStatChange {
    /// The amount of change.
    pub change: i64,
    /// The stat being affected.
    pub stat: NamedApiResource<Stat>,
}

/// [PastMoveStatValues official documentation](https://pokeapi.co/docs/v2#pastmovestatvalues)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct PastMoveStatValues {
    /// The percent value of how likely this move is to be successful.
    pub accuracy: Option<i64>,
    /// The percent value of how likely it is this moves effect will take effect.
    pub effect_chance: Option<i64>,
    /// The base power of this move with a value of 0 if it does not have a base power.
    pub power: Option<i64>,
    /// Power points. The number of times this move can be used.
    pub pp: Option<i64>,
    /// The effect of this move listed in different languages.
    pub effect_entries: Vec<VerboseEffect>,
    /// The elemental type of this move.
    #[serde(rename = "type")]
    pub type_: Option<NamedApiResource<Type>>,
    /// The version group in which these move stat values were in effect.
    pub version_group: NamedApiResource<VersionGroup>,
}

/// [MoveAilment official documentation](https://pokeapi.co/docs/v2#moveailment)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveAilment {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// A list of moves that cause this ailment.
    pub moves: Vec<NamedApiResource<Move>>,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
}

/// [MoveBattleStyle official documentation](https://pokeapi.co/docs/v2#movebattlestyle)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveBattleStyle {
    /// 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>,
}

/// [MoveCategory official documentation](https://pokeapi.co/docs/v2#movecategory)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveCategory {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// A list of moves that fall into this category.
    pub moves: Vec<NamedApiResource<Move>>,
    /// The description of this resource listed in different languages.
    pub descriptions: Vec<Description>,
}

/// [MoveDamageClass official documentation](https://pokeapi.co/docs/v2#movedamageclass)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveDamageClass {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The description of this resource listed in different languages.
    pub descriptions: Vec<Description>,
    /// A list of moves that fall into this damage class.
    pub moves: Vec<NamedApiResource<Move>>,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
}

/// [MoveLearnMethod official documentation](https://pokeapi.co/docs/v2#movelearnmethod)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveLearnMethod {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The description of this resource listed in different languages.
    pub descriptions: Vec<Description>,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
    /// A list of version groups where moves can be learned through this method.
    pub version_groups: Vec<NamedApiResource<VersionGroup>>,
}

/// [MoveTarget official documentation](https://pokeapi.co/docs/v2#movetarget)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MoveTarget {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The description of this resource listed in different languages.
    pub descriptions: Vec<Description>,
    /// A list of moves that that are directed at this target.
    pub moves: Vec<NamedApiResource<Move>>,
    /// The name of this resource listed in different languages.ƒ
    pub names: Vec<Name>,
}