Struct OmniConfig 

pub struct OmniConfig {
    pub default_target: Option<String>,
    pub targets: BTreeMap<String, Target>,
}

The whole declarative connection config.

Fields

default_target: Option<String>

Target used when --target is omitted.

targets: BTreeMap<String, Target>

Named connection targets.

Implementations

impl OmniConfig

pub fn parse(yaml: &str) -> Result<OmniConfig, AppError>

Parse config from a YAML string and validate it.

Errors

AppError::validation on a YAML parse error or a semantic validation failure (bad target shape, dangling/cyclic group, missing default).

pub fn to_yaml(&self) -> Result<String, AppError>

Serialize the config back to YAML.

Errors

AppError::internal if serialization fails.

pub fn validate(&self) -> Result<(), AppError>

Validate target shapes, group references, group acyclicity, and the default target.

Errors

AppError::validation describing the first problem found.

pub fn effective_target<'a>( &'a self, cli: Option<&'a str>, ) -> Result<&'a str, AppError>

The effective target name: cli if given, else default_target.

Errors

AppError::validation if neither is set.

pub fn target(&self, name: &str) -> Result<&Target, AppError>

Look up a target by name.

Errors

AppError::validation if the target is not defined.

pub fn resolve_endpoints( &self, name: &str, ) -> Result<Vec<ResolvedEndpoint>, AppError>

Resolve a target name to its de-duplicated, ordered list of leaf endpoints, expanding groups recursively.

Errors

AppError::validation for an unknown target or a group cycle.

Trait Implementations

impl Clone for OmniConfig

fn clone(&self) -> OmniConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OmniConfig

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

Formats the value using the given formatter.

impl Default for OmniConfig

fn default() -> OmniConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OmniConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<OmniConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for OmniConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for OmniConfig

fn eq(&self, other: &OmniConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OmniConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OmniConfig

impl StructuralPartialEq for OmniConfig