routee-compass 0.19.2

The RouteE-Compass energy-aware routing engine
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

use super::CompassComponentError;
use crate::app::map_matching::MapMatchingAppError;
use crate::plugin::{input::InputPluginError, output::OutputPluginError, PluginError};
use config::ConfigError;
use routee_compass_core::config::CompassConfigurationError;
use routee_compass_core::{
    algorithm::search::SearchError,
    model::{
        constraint::ConstraintModelError, cost::CostModelError, map::MapError,
        network::NetworkError, state::StateModelError, termination::TerminationModelError,
        traversal::TraversalModelError,
    },
};

#[derive(thiserror::Error, Debug)]
pub enum CompassAppError {
    // TOP-LEVEL FAILURES
    //   errors observed during build and run of compass that are not due to the search modules
    #[error("failure building compass app: {0}")]
    BuildFailure(String),
    #[error("failure while running app: {0}")]
    CompassFailure(String),
    #[error("internal error: {0}")]
    InternalError(String),
    #[error("error accessing shared read-only dataset: {0}")]
    ReadOnlyPoisonError(String),

    // TRANSPARENT MODULE FAILURES
    //   failures from these modules are detailed enough to get surfaced directly to the user
    #[error(transparent)]
    ConfigFailure(#[from] ConfigError),
    #[error(transparent)]
    CompassConfigurationError(#[from] CompassConfigurationError),
    #[error(transparent)]
    CompassComponentError(#[from] CompassComponentError),
    #[error(transparent)]
    SearchFailure(#[from] SearchError),
    #[error(transparent)]
    PluginError(#[from] PluginError),
    #[error(transparent)]
    InputPluginFailure(#[from] InputPluginError),
    #[error(transparent)]
    OutputPluginFailure(#[from] OutputPluginError),
    #[error(transparent)]
    MapMatchingFailure(#[from] MapMatchingAppError),

    // CONTEXTUALIZED MODULE FAILURES
    //   failures from these modules are happening outside of the context of running the search,
    //   which is clarified for the user and may help direct where to look to solve the problem.
    #[error("While interacting with the map model outside of the context of search, an error occurred. Source: {source}")]
    MappingFailure {
        #[from]
        source: MapError,
    },
    #[error("While interacting with the state model outside of the context of search, an error occurred. Source: {source}")]
    StateFailure {
        #[from]
        source: StateModelError,
    },
    #[error("While interacting with the network model outside of the context of search, an error occurred. Source: {source}")]
    NetworkFailure {
        #[from]
        source: NetworkError,
    },
    #[error("While interacting with the termination model outside of the context of search, an error occurred. Source: {source}")]
    TerminationModelFailure {
        #[from]
        source: TerminationModelError,
    },
    #[error("While interacting with the traversal model outside of the context of search, an error occurred. Source: {source}")]
    TraversalModelFailure {
        #[from]
        source: TraversalModelError,
    },
    #[error("While interacting with the constraint model outside of the context of search, an error occurred. Source: {source}")]
    ConstraintModelFailure {
        #[from]
        source: ConstraintModelError,
    },
    #[error("While interacting with the cost model outside of the context of search, an error occurred. Source: {source}")]
    CostFailure {
        #[from]
        source: CostModelError,
    },
    #[error("failure due to JSON: {source}")]
    JsonError {
        #[from]
        source: serde_json::Error,
    },
}