eve_esi 0.4.9

Thread-safe, asynchronous client for EVE Online's ESI & OAuth2
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

//! # EVE ESI Market Enums
//!
//! Provides enums related to markets in EVE Online
//!
//! ## Enums
//! - [`MarketOrderRange`]: Indicates the the range of a market order
//! - [`HistoricalMarketOrderState`]: Indicates whether a historical market order expired or was cancelled
//! - [`OrderType`]: Represents the type of order when requesting a list of orders within a region

use std::fmt;

use serde::{Deserialize, Serialize};

/// Indicates the the range of a market order
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/CharactersCharacterIdOrdersGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub enum MarketOrderRange {
    /// Market order has a range of within 1 jump
    #[serde(rename = "1")]
    OneJump,
    /// Market order has a range of within 2 jumps
    #[serde(rename = "2")]
    TwoJumps,
    /// Market order has a range of within 3 jumps
    #[serde(rename = "3")]
    ThreeJumps,
    /// Market order has a range of within 4 jumps
    #[serde(rename = "4")]
    FourJumps,
    /// Market order has a range of within 5 jumps
    #[serde(rename = "5")]
    FiveJumps,
    /// Market order has a range of within 10 jumps
    #[serde(rename = "10")]
    TenJumps,
    /// Market order has a range of within 20 jumps
    #[serde(rename = "20")]
    TwentyJumps,
    /// Market order has a range of within 30 jumps
    #[serde(rename = "30")]
    ThirtyJumps,
    /// Market order has a range of within 40 jumps
    #[serde(rename = "40")]
    FourtyJumps,
    /// Market order has a range of within its current region
    #[serde(rename = "region")]
    Region,
    /// Market order has a range of within its current system
    #[serde(rename = "solarsystem")]
    SolarSystem,
    /// Market order has a range of within its current station
    #[serde(rename = "station")]
    Station,
}

/// Indicates whether a historical market order expired or was cancelled
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/CharactersCharacterIdOrdersHistoryGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub enum HistoricalMarketOrderState {
    /// Market order was cancelled
    #[serde(rename = "cancelled")]
    Cancelled,
    /// Market order has expired
    #[serde(rename = "expired")]
    Expired,
}

/// Represents the type of order when requesting a list of orders within a region
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/operations/GetMarketsRegionIdOrders>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub enum OrderType {
    /// Request only buy orders
    #[serde(rename = "buy")]
    Buy,
    /// Request only sell orders
    #[serde(rename = "sell")]
    Sell,
    /// Request both buy & sell orders
    #[serde(rename = "all")]
    All,
}

// Required for ESI endpoint macro URL formatting
//
// This enum is used as an argument when requesting market orders within a region
impl fmt::Display for OrderType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let s = match self {
            OrderType::Buy => "buy",
            OrderType::Sell => "sell",
            OrderType::All => "all",
        };
        write!(f, "{}", s)
    }
}

#[cfg(test)]
mod market_enum_tests {
    use crate::model::enums::market::OrderType;

    /// Ensures [`OrderType`] displays as string "buy"
    #[test]
    fn test_order_type_buy_display() {
        assert_eq!(OrderType::Buy.to_string(), "buy")
    }

    /// Ensures [`OrderType`] displays as string "sell"
    #[test]
    fn test_order_type_sell_display() {
        assert_eq!(OrderType::Sell.to_string(), "sell")
    }

    /// Ensures [`OrderType`] displays as string "all"
    #[test]
    fn test_order_type_all_display() {
        assert_eq!(OrderType::All.to_string(), "all")
    }
}