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

//! Items group models

use super::{
    evolution::EvolutionChain,
    games::Version,
    pokemon::Pokemon,
    resource::{
        ApiResource, Description, Effect, GenerationGameIndex, MachineVersionDetail, Name,
        NamedApiResource, VerboseEffect, VersionGroupFlavorText,
    },
};

/// [Item official documentation](https://pokeapi.co/docs/v2#item)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct Item {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The price of this item in stores.
    pub cost: i64,
    /// The power of the move Fling when used with this item.
    pub fling_power: Option<i64>,
    /// The effect of the move Fling when used with this item.
    pub fling_effect: Option<NamedApiResource<ItemFlingEffect>>,
    /// A list of attributes this item has.
    pub attributes: Vec<NamedApiResource<ItemAttribute>>,
    /// The category of items this item falls into.
    pub category: NamedApiResource<ItemCategory>,
    /// The effect of this ability listed in different languages.
    pub effect_entries: Vec<VerboseEffect>,
    /// The flavor text of this ability listed in different languages.
    pub flavor_text_entries: Vec<VersionGroupFlavorText>,
    /// A list of game indices relevent to this item by generation.
    pub game_indices: Vec<GenerationGameIndex>,
    /// The name of this item listed in different languages.
    pub names: Vec<Name>,
    /// A set of sprites used to depict this item in the game.
    pub sprites: ItemSprites,
    /// A list of Pokémon that might be found in the wild holding this item.
    pub held_by_pokemon: Vec<ItemHolderPokemon>,
    /// An evolution chain this item requires to produce a bay during mating.
    pub baby_trigger_for: Option<ApiResource<EvolutionChain>>,
    /// A list of the machines related to this item.
    pub machines: Vec<MachineVersionDetail>,
}

/// [ItemSprites official documentation](https://pokeapi.co/docs/v2#itemsprites)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ItemSprites {
    /// The default depiction of this item.
    pub default: Option<String>,
}

/// [ItemHolderPokemon official documentation](https://pokeapi.co/docs/v2#itemholderpokemon)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ItemHolderPokemon {
    /// The Pokémon that holds this item.
    pub pokemon: NamedApiResource<Pokemon>,
    /// The details for the version that this item is held in by the Pokémon.
    pub version_details: Vec<ItemHolderPokemonVersionDetail>,
}

/// [ItemHolderPokemonVersionDetail official documentation](https://pokeapi.co/docs/v2#itemholderpokemonversiondetail)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ItemHolderPokemonVersionDetail {
    /// How often this Pokémon holds this item in this version.
    pub rarity: i64,
    /// The version that this item is held in by the Pokémon.
    pub version: NamedApiResource<Version>,
}

/// [ItemAttribute official documentation](https://pokeapi.co/docs/v2#itemattribute)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ItemAttribute {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// A list of items that have this attribute.
    pub items: Vec<NamedApiResource<Item>>,
    /// The name of this item attribute listed in different languages.
    pub names: Vec<Name>,
    /// The description of this item attribute listed in different languages.
    pub descriptions: Vec<Description>,
}

/// [ItemCategory official documentation](https://pokeapi.co/docs/v2#itemcategory)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ItemCategory {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// A list of items that are a part of this category.
    pub items: Vec<NamedApiResource<Item>>,
    /// The name of this item category listed in different languages.
    pub names: Vec<Name>,
    /// The pocket items in this category would be put in.
    pub pocket: NamedApiResource<ItemPocket>,
}

/// [ItemFlingEffect official documentation](https://pokeapi.co/docs/v2#itemflingeffect)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ItemFlingEffect {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// The result of this fling effect listed in different languages.
    pub effect_entries: Vec<Effect>,
    /// A list of items that have this fling effect.
    pub items: Vec<NamedApiResource<Item>>,
}

/// [ItemPocket official documentation](https://pokeapi.co/docs/v2#itempocket)
#[derive(Default, Debug, Clone, PartialEq, Eq, serde::Deserialize)]
pub struct ItemPocket {
    /// The identifier for this resource.
    pub id: i64,
    /// The name for this resource.
    pub name: String,
    /// A list of item categories that are relevant to this item pocket.
    pub categories: Vec<NamedApiResource<ItemCategory>>,
    /// The name of this resource listed in different languages.
    pub names: Vec<Name>,
}