Struct CompassAppConfig 

pub struct CompassAppConfig {
    pub algorithm: SearchAlgorithmConfig,
    pub state: Option<Vec<(String, StateVariableConfig)>>,
    pub cost: CostModelConfig,
    pub label: Value,
    pub mapping: MapModelConfig,
    pub graph: GraphConfig,
    pub search: OneOrMany<SearchConfig>,
    pub plugin: PluginConfig,
    pub termination: TerminationModel,
    pub system: CompassAppSystemParameters,
    pub map_matching: Value,
}

high-level application configuration that orchestrates together configuration requirements for the various components making up a [CompassApp].

Fields

algorithm: SearchAlgorithmConfig

state: Option<Vec<(String, StateVariableConfig)>>

cost: CostModelConfig

label: Value

mapping: MapModelConfig

graph: GraphConfig

search: OneOrMany<SearchConfig>

section containing a single search config or an array of search configs (OneOrMany).

plugin: PluginConfig

termination: TerminationModel

system: CompassAppSystemParameters

map_matching: Value

Implementations

impl CompassAppConfig

pub fn from_str( config: &str, config_path: &str, format: FileFormat, ) -> Result<CompassAppConfig, CompassAppError>

reads a stringified configuration file with provided format and constructs a CompassAppConfig

impl CompassAppConfig

pub fn to_pretty_string(&self) -> Result<String, CompassAppError>

Returns a pretty-printed JSON representation of this config. Useful for debugging and logging the exact configuration being used.

pub fn build_traversal_model_services( &self, builders: &CompassBuilderInventory, ) -> Result<Vec<Arc<dyn TraversalModelService>>, CompassAppError>

pub fn build_constraint_model_services( &self, builders: &CompassBuilderInventory, ) -> Result<Vec<Arc<dyn ConstraintModelService>>, CompassAppError>

Trait Implementations

impl Clone for CompassAppConfig

fn clone(&self) -> CompassAppConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompassAppConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompassAppConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CompassAppConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Path> for CompassAppConfig

type Error = CompassAppError

The type returned in the event of a conversion error.

fn try_from(config_path: &Path) -> Result<Self, Self::Error>

Performs the conversion.