ezomyte 0.0.2

Path of Exile API client library
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

//! Item mod (modifier).

                            mod id;
                            mod info;
#[cfg(feature = "mods_db")] mod database;
#[cfg(test)]                mod tests;

pub use self::id::{ModId, ModType};
pub use self::info::ModInfo;


use std::fmt;
use std::sync::Arc;

use smallvec::SmallVec;


/// A single item mod occurrence.
#[derive(Clone)]
pub struct Mod {
    /// Type of the mod.
    type_: ModType,
    /// Original text of the mod.
    text: String,
    /// Parsed mod information & values.
    data: Option<(Arc<ModInfo>, ModValues)>,
}

impl Mod {
    /// Create `Mod` from given mod text that's found on an item.
    pub fn new<T: Into<String>>(type_: ModType, text: T) -> Self {
        let text = text.into();

        // Resolve mod text against item mod database if it's available.
        #[cfg(feature = "mods_db")]
        let data = database::ITEM_MODS.resolve(type_, &text);
        #[cfg(not(feature = "mods_db"))]
        let data = None;

        Mod{type_, text, data}
    }
}

impl Mod {
    /// Mod type (explicit, implicit, etc.).
    #[inline]
    pub fn mod_type(&self) -> ModType {
        self.type_
    }

    /// Information about the particular item mod.
    #[inline]
    #[cfg(feature = "mods_db")]
    pub fn info(&self) -> Option<&ModInfo> {
        self.data.as_ref().map(|&(ref mi, _)| &**mi)
    }

    /// Values associated with this particular mod's occurrence, if known.
    ///
    /// For example, if the mod is "+6% increased Attack Speed",
    /// its values include a single number 6.
    ///
    /// Note that not every number in the mod text is an actual mod value.
    /// A typical example is "Has 1 Abyssal Socket",
    /// where "1" is just a constant part of the mod text.
    #[inline]
    #[cfg(feature = "mods_db")]
    pub fn values(&self) -> Option<&ModValues> {
        self.data.as_ref().map(|&(_, ref mv)| mv)
    }

    /// Mod text as string.
    #[inline]
    pub fn as_str(&self) -> &str {
        self.text.as_str()
    }
}

impl fmt::Debug for Mod {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        let mut ds = fmt.debug_struct("Mod");
        ds.field("type", &self.type_);
        match self.data {
            Some((ref mi, ref vs)) => {
                ds.field("text", &mi.text());
                ds.field("values", vs);
            }
            None => { ds.field("text", &self.text); }
        }
        ds.finish()
    }
}


/// Type of a mod parameter value
/// -- that is, the number that varies between occurrences of a mod on items.
pub type ModValue = f64;

/// Type for parameter values of a single mod.
///
/// Currently, no mod seems to have more than two values associated with it,
/// so this container holds zero, one, or two items.
pub type ModValues = SmallVec<[ModValue; 4]>;