msq 0.2.1

Rust library implementation of the legacy Master Server Query Protocol
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

use std::io::{Result, Error, ErrorKind};

/// Region enum to restrict the servers region the query searches for
///
/// * Intended to be used with: [`MSQClient`](crate::MSQClient) and
/// [`MSQClientBlock`](crate::MSQClientBlock)
///
/// # Reference
/// | `Region` Enum          | Region            | Byte |
/// | ---------------------- | ----------------- | ---- |
/// | `Region::USEast`       | US East coast     | 0x00 |
/// | `Region::USWest`       | US West coast     | 0x01 |
/// | `Region::SouthAmerica` | South America     | 0x02 |
/// | `Region::Europe`       | Europe            | 0x03 |
/// | `Region::Asia`         | Asia              | 0x04 |
/// | `Region::Australia`    | Australia         | 0x05 |
/// | `Region::MiddleEast`   | Middle East       | 0x06 |
/// | `Region::Africa`       | Africa            | 0x07 |
/// | `Region::All`          | Rest of the world | 0xFF |
///
#[derive(Debug, PartialEq)]
pub enum Region {
    USEast,
    USWest,
    SouthAmerica,
    Europe,
    Asia,
    Australia,
    MiddleEast,
    Africa,
    All, // Rest of the world
}

impl Region {
    /// Return raw u8 byte code of its specified region
    ///
    /// # Example
    /// ```rust
    /// use msq::Region;
    ///
    /// let region_hex_str = format!("{:#04x}", Region::All.as_u8());
    /// assert_eq!(&region_hex_str, "0xff");
    ///
    /// let region_hex_str = format!("{:#04x}", Region::Europe.as_u8());
    /// assert_eq!(&region_hex_str, "0x03");
    /// ```
    pub fn as_u8(&self) -> u8 {
        match self {
            Self::USEast => 0x00,
            Self::USWest => 0x01,
            Self::SouthAmerica => 0x02,
            Self::Europe => 0x03,
            Self::Asia => 0x04,
            Self::Australia => 0x05,
            Self::MiddleEast => 0x06,
            Self::Africa => 0x07,
            Self::All => 0xFF,
        }
    }

    pub fn from_u8(code: u8) -> Result<Self> {
        match code {
            0x00 => Ok(Self::USEast),
            0x01 => Ok(Self::USWest),
            0x02 => Ok(Self::SouthAmerica),
            0x03 => Ok(Self::Europe),
            0x04 => Ok(Self::Asia),
            0x05 => Ok(Self::Australia),
            0x06 => Ok(Self::MiddleEast),
            0x07 => Ok(Self::Africa),
            0xFF => Ok(Self::All),
            _ => Err(Error::new(ErrorKind::Other, "Invalid code")),
        }
    }
}