gridish 2.0.0

Library for working with British and Irish national grid strings.
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

use crate::constants::*;

#[cfg(any(feature = "tetrads", feature = "quadrants"))]
pub(crate) enum Suffix {
    #[cfg(feature = "quadrants")]
    Quadrant,
    #[cfg(feature = "tetrads")]
    Tetrad,
}

/// Supported resolutions for working with Grid References.
/// Represents the size of the square (in metres) that a point can fall within.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum Resolution {
    /// 100km Square
    _100km,
    /// 50km Square (Quadrant of 100km Square)
    #[cfg(feature = "quadrants")]
    _50km,
    /// 10km Square
    _10km,
    /// 5km Square (Quadrant of 10km Square)
    #[cfg(feature = "quadrants")]
    _5km,
    /// 2km Square (Tetrad)
    #[cfg(feature = "tetrads")]
    _2km,
    /// 1km Square
    _1km,
    /// 500m Square (Quadrant of 1km Square)
    #[cfg(feature = "quadrants")]
    _500m,
    /// 100m Square
    _100m,
    /// 50m Square (Quadrant of 100m Square)
    #[cfg(feature = "quadrants")]
    _50m,
    /// 10m Square
    _10m,
    /// 5m Square (Quadrant of 10m Square)
    #[cfg(feature = "quadrants")]
    _5m,
    /// 1m Square
    _1m,
}

impl Resolution {
    /// Returns the Resolution in metres
    ///
    /// # Example
    /// ```
    /// # use gridish::Resolution;
    /// assert_eq!(Resolution::_1km.metres(), 1_000);
    /// ```
    pub fn metres(&self) -> u32 {
        match self {
            Resolution::_100km => _100KM,
            #[cfg(feature = "quadrants")]
            Resolution::_50km => _50KM,
            Resolution::_10km => _10KM,
            #[cfg(feature = "quadrants")]
            Resolution::_5km => _5KM,
            #[cfg(feature = "tetrads")]
            Resolution::_2km => _2KM,
            Resolution::_1km => _1KM,
            #[cfg(feature = "quadrants")]
            Resolution::_500m => _500M,
            Resolution::_100m => _100M,
            #[cfg(feature = "quadrants")]
            Resolution::_50m => _50M,
            Resolution::_10m => _10M,
            #[cfg(feature = "quadrants")]
            Resolution::_5m => _5M,
            Resolution::_1m => _1M,
        }
    }

    // Determines how the given resolution should be represented as a string
    cfg_select! {
        any(feature = "tetrads", feature = "quadrants") => {
            pub(crate) fn representation(&self) -> (u32, u8, Option<Suffix>) {
                match self {
                    Resolution::_100km => (_100KM, 0, None),
                    #[cfg(feature = "quadrants")]
                    Resolution::_50km => (_100KM, 0, Some(Suffix::Quadrant)),
                    Resolution::_10km => (_10KM, 2, None),
                    #[cfg(feature = "quadrants")]
                    Resolution::_5km => (_10KM, 2, Some(Suffix::Quadrant)),
                    #[cfg(feature = "tetrads")]
                    Resolution::_2km => (_10KM, 2, Some(Suffix::Tetrad)),
                    Resolution::_1km => (_1KM, 4, None),
                    #[cfg(feature = "quadrants")]
                    Resolution::_500m => (_1KM, 4, Some(Suffix::Quadrant)),
                    Resolution::_100m => (_100M, 6, None),
                    #[cfg(feature = "quadrants")]
                    Resolution::_50m => (_100M, 6, Some(Suffix::Quadrant)),
                    Resolution::_10m => (_10M, 8, None),
                    #[cfg(feature = "quadrants")]
                    Resolution::_5m => (_10M, 8, Some(Suffix::Quadrant)),
                    Resolution::_1m => (_1M, 10, None),
                }
            }
        }
        _ => {
            pub(crate) fn representation(&self) -> (u32, u8) {
                match self {
                    Resolution::_100km => (_100KM, 0),
                    Resolution::_10km => (_10KM, 2),
                    Resolution::_1km => (_1KM, 4),
                    Resolution::_100m => (_100M, 6),
                    Resolution::_10m => (_10M, 8),
                    Resolution::_1m => (_1M, 10),
                }
            }
        }
    }
}