rustemon 2.2.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

//! Common models

use std::marker::PhantomData;

use super::{
    encounters::{EncounterConditionValue, EncounterMethod},
    games::{Generation, Version, VersionGroup},
    machines::Machine,
    utility::Language,
};

/// [NamedApiResourceList official documentation](https:///pokeapi.co/docs/v2#namedapiresourcelist)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct NamedApiResourceList<T> {
    /// The total number of resources available from this API.
    pub count: Option<i64>,
    /// The URL for the next page in the list.
    pub next: Option<String>,
    /// The URL for the previous page in the list.
    pub previous: Option<String>,
    /// A list of named API resources.
    pub results: Option<Vec<NamedApiResource<T>>>,
}

/// [ApiResource official documentation](https://pokeapi.co/docs/v2#apiresource)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ApiResource<T> {
    /// The URL of the referenced resource.
    pub url: Option<String>,
    #[serde(skip)]
    _marker: PhantomData<T>,
}

/// [Description official documentation](https://pokeapi.co/docs/v2#description)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Description {
    /// The localized description for an API resource in a specific language.
    pub description: Option<String>,
    /// The language this name is in.
    pub language: Option<NamedApiResource<Language>>,
}

/// [Effect official documentation](https://pokeapi.co/docs/v2#effect)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Effect {
    /// The localized effect text for an API resource in a specific language.
    pub effect: Option<String>,
    /// The language this effect is in.
    pub language: Option<NamedApiResource<Language>>,
}

/// [Encounter official documentation](https://pokeapi.co/docs/v2#encounter)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Encounter {
    /// The lowest level the Pokémon could be encountered at.
    pub min_level: Option<i64>,
    /// The highest level the Pokémon could be encountered at.
    pub max_level: Option<i64>,
    /// A list of condition values that must be in effect for this encounter to occur.
    pub condition_values: Option<Vec<NamedApiResource<EncounterConditionValue>>>,
    /// Percent chance that this encounter will occur.
    pub chance: Option<i64>,
    /// The method by which this encounter happens.
    pub method: Option<NamedApiResource<EncounterMethod>>,
}

/// [FlavorText official documentation](https://pokeapi.co/docs/v2#flavortext)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct FlavorText {
    /// The localized flavor text for an API resource in a specific language.
    pub flavor_text: Option<String>,
    /// The language this name is in.
    pub language: Option<NamedApiResource<Language>>,
    /// The game version this flavor text is extracted from.
    pub version: Option<NamedApiResource<Version>>,
}

/// [GenerationGameIndex official documentation](https://pokeapi.co/docs/v2#generationgameindex)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct GenerationGameIndex {
    /// The internal id of an API resource within game data.
    pub game_index: Option<i64>,
    /// The generation relevent to this game index.
    pub generation: Option<NamedApiResource<Generation>>,
}

/// [MachineVersionDetail official documentation](https://pokeapi.co/docs/v2#machineversiondetail)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct MachineVersionDetail {
    /// The machine that teaches a move from an item.
    pub machine: Option<ApiResource<Machine>>,
    /// The version group of this specific machine.
    pub version_group: Option<NamedApiResource<VersionGroup>>,
}

/// [Name official documentation](https://pokeapi.co/docs/v2#name)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Name {
    /// The localized name for an API resource in a specific language.
    pub name: Option<String>,
    /// The language this name is in.
    pub language: Option<NamedApiResource<Language>>,
}

/// [VerboseEffect official documentation](https://pokeapi.co/docs/v2#verboseeffect)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct VerboseEffect {
    /// The localized effect text for an API resource in a specific language.
    pub effect: Option<String>,
    /// The localized effect text in brief.
    pub short_effect: Option<String>,
    /// The language this effect is in.
    pub language: Option<NamedApiResource<Language>>,
}

/// [VersionEncounterDetail official documentation](https://pokeapi.co/docs/v2#versionencounterdetail)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct VersionEncounterDetail {
    /// The game version this encounter happens in.
    pub version: Option<NamedApiResource<Version>>,
    /// The total percentage of all encounter potential.
    pub max_chance: Option<i64>,
    /// A list of encounters and their specifics.
    pub encounter_details: Option<Vec<Encounter>>,
}

/// [VersionGameIndex official documentation](https://pokeapi.co/docs/v2#versiongameindex)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct VersionGameIndex {
    /// The internal id of an API resource within game data.
    pub game_index: Option<i64>,
    /// The version relevent to this game index.
    pub version: Option<NamedApiResource<Version>>,
}

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

/// [NamedApiResource official documentation](https://pokeapi.co/docs/v2#namedapiresource)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct NamedApiResource<T> {
    /// The name of the referenced resource.
    pub name: Option<String>,
    /// The URL of the referenced resource.
    pub url: Option<String>,
    #[serde(skip)]
    _marker: PhantomData<T>,
}