rfham-geo 0.1.0

Core locator data type and lookup functions for location intormation.
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

//!
//! Provides the traits [`GridIdentifier`], [`GridPoly`], and [`GridSystem`].
//!
//! More detailed description
//!
//! # Examples
//!
//! ```rust
//! ```
//!

use lat_long::Coordinate;
use rfham_core::Agency;
use std::{fmt::Display, str::FromStr};

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

pub trait GridIdentifier:
    Clone + Display + FromStr + PartialEq + Eq + Into<String> + AsRef<str> + From<Coordinate>
{
    fn is_valid(s: &str) -> bool;
    fn as_str(&self) -> &str {
        self.as_ref()
    }
}

pub trait GridPolygon {
    type Identifier: GridIdentifier;
    fn id(&self) -> &Self::Identifier;
    fn vertices(&self) -> Vec<Coordinate>;
}

pub trait GridSystem {
    type Identifier: GridIdentifier;
    type Poly: GridPolygon<Identifier = Self::Identifier>;

    fn name(&self) -> &str;

    fn defining_agency(&self) -> Agency;

    fn lookup_id(&self, id: &Self::Identifier) -> Option<Self::Poly>;

    fn lookup_point(&self, point: &Coordinate) -> Option<Self::Poly> {
        self.lookup_id(&Self::Identifier::from(*point))
    }
}

// ------------------------------------------------------------------------------------------------
// Sub-Modules
// ------------------------------------------------------------------------------------------------

pub mod maidenhead;