rfham-geo 0.1.1

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

//! Error and result types for `rfham-geo`.
//!
//! [`GeoError`] is the single error enum used across all modules in this crate.
//! [`GeoResult<T>`] is a type alias for `std::result::Result<T, GeoError>`.

use lat_long::Error as LatLongError;
use reqwest::Error as RequestError;
use reqwest::StatusCode;
use rfham_core::error::CoreError;
use serde_json::Error as JsonError;
use thiserror::Error;

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

///
/// The `Error` type for this crate.
///
#[derive(Debug, Error)]
pub enum GeoError {
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    #[error("An error occured converting latitude/longitude value; error: {0}")]
    LatLong(#[from] LatLongError),

    #[error("Cannot produce a Maidenhead grid locator for either North/South poles")]
    NoPolarGrid,

    #[error("An error occured in a Geo-IP provider; error: {0}")]
    GeoIpProvider(String),

    #[error("An HTTP service returned non-success code ; status-code: {0}")]
    Http(StatusCode),

    #[error("An error occured calling an HTTP service; status-code: {0}")]
    Reqwest(#[from] RequestError),

    #[error("Core library error detected; error: {0}")]
    Core(#[from] CoreError),

    #[error("An error occured serializing/deserializing JSON; error: {0}")]
    Serialization(#[from] JsonError),
}

///
/// A `Result` type that specifically uses this crate's `Error`.
///
pub type GeoResult<T> = std::result::Result<T, GeoError>;