Skip to main content

ConfigReader

qubit_config

Trait ConfigReader 

Source 
pub trait ConfigReader {

Show 27 methods    // Required methods
    fn is_enable_variable_substitution(&self) -> bool;
    fn max_substitution_depth(&self) -> usize;
    fn description(&self) -> Option<&str>;
    fn get_property(&self, name: &str) -> Option<&Property>;
    fn len(&self) -> usize;
    fn is_empty(&self) -> bool;
    fn keys(&self) -> Vec<String>;
    fn contains(&self, name: &str) -> bool;
    fn get<T>(&self, name: &str) -> ConfigResult<T>
       where MultiValues: MultiValuesFirstGetter<T>;
    fn get_list<T>(&self, name: &str) -> ConfigResult<Vec<T>>
       where MultiValues: MultiValuesGetter<T>;
    fn get_optional<T>(&self, name: &str) -> ConfigResult<Option<T>>
       where MultiValues: MultiValuesFirstGetter<T>;
    fn get_optional_list<T>(&self, name: &str) -> ConfigResult<Option<Vec<T>>>
       where MultiValues: MultiValuesGetter<T>;
    fn contains_prefix(&self, prefix: &str) -> bool;
    fn iter_prefix<'a>(
        &'a self,
        prefix: &'a str,
    ) -> Box<dyn Iterator<Item = (&'a str, &'a Property)> + 'a>;
    fn iter<'a>(
        &'a self,
    ) -> Box<dyn Iterator<Item = (&'a str, &'a Property)> + 'a>;
    fn is_null(&self, name: &str) -> bool;
    fn subconfig(
        &self,
        prefix: &str,
        strip_prefix: bool,
    ) -> ConfigResult<Config>;
    fn deserialize<T>(&self, prefix: &str) -> ConfigResult<T>
       where T: DeserializeOwned;
    fn prefix_view(&self, prefix: &str) -> ConfigPrefixView<'_>;

    // Provided methods
    fn get_or<T>(&self, name: &str, default: T) -> T
       where MultiValues: MultiValuesFirstGetter<T> { ... }
    fn resolve_key(&self, name: &str) -> String { ... }
    fn get_string(&self, name: &str) -> ConfigResult<String> { ... }
    fn get_string_or(&self, name: &str, default: &str) -> String { ... }
    fn get_string_list(&self, name: &str) -> ConfigResult<Vec<String>> { ... }
    fn get_string_list_or(&self, name: &str, default: &[&str]) -> Vec<String> { ... }
    fn get_optional_string(&self, name: &str) -> ConfigResult<Option<String>> { ... }
    fn get_optional_string_list(
        &self,
        name: &str,
    ) -> ConfigResult<Option<Vec<String>>> { ... }

}
Expand description

Read-only configuration interface.

This trait allows consumers to read configuration values without requiring ownership of a crate::Config. Both crate::Config and crate::ConfigPrefixView implement it.

Its required methods mirror the read-only surface of crate::Config (metadata, raw properties, iteration, subtree extraction, and serde deserialization), with prefix views resolving keys relative to their logical prefix.

Author: Haixing Hu

Required Methods§

Source

fn is_enable_variable_substitution(&self) -> bool

Returns whether ${...} variable substitution is applied when reading string values.

§Returns

true if substitution is enabled for this reader.

Source

fn max_substitution_depth(&self) -> usize

Returns the maximum recursion depth allowed when resolving nested ${...} references.

§Returns

Maximum substitution depth (see [crate::constants::DEFAULT_MAX_SUBSTITUTION_DEPTH] for the default used by crate::Config).

Source

fn description(&self) -> Option<&str>

Returns the optional human-readable description attached to this configuration (the whole document; prefix views expose the same value as the underlying crate::Config).

Source

fn get_property(&self, name: &str) -> Option<&Property>

Returns a reference to the raw Property for name, if present.

For a ConfigPrefixView, name is resolved relative to the view prefix (same rules as Self::get).

Source

fn len(&self) -> usize

Number of configuration entries visible to this reader (all keys for crate::Config; relative keys only for a ConfigPrefixView).

Source

fn is_empty(&self) -> bool

Returns true when Self::len is zero.

Source

fn keys(&self) -> Vec<String>

All keys visible to this reader (relative keys for a prefix view).

Source

fn contains(&self, name: &str) -> bool

Returns whether a property exists for the given key.

§Parameters
§Returns

true if the key is present.

Source

fn get<T>(&self, name: &str) -> ConfigResult<T>
where MultiValues: MultiValuesFirstGetter<T>,

Reads the first stored value for name and converts it to T.

§Type parameters
  • T - Target type; requires MultiValues to implement MultiValuesFirstGetter for T.
§Parameters
  • name - Configuration key.
§Returns

The converted value on success, or a crate::ConfigError if the key is missing, empty, or not convertible.

Source

fn get_list<T>(&self, name: &str) -> ConfigResult<Vec<T>>
where MultiValues: MultiValuesGetter<T>,

Reads all stored values for name and converts each element to T.

§Type parameters
  • T - Element type; requires MultiValues to implement MultiValuesGetter for T.
§Parameters
  • name - Configuration key.
§Returns

A vector of values on success, or a crate::ConfigError on failure.

Source

fn get_optional<T>(&self, name: &str) -> ConfigResult<Option<T>>
where MultiValues: MultiValuesFirstGetter<T>,

Gets an optional value with the same semantics as crate::Config::get_optional.

§Type parameters
  • T - Target type; requires MultiValues to implement MultiValuesFirstGetter for T.
§Parameters
  • name - Configuration key (relative for a prefix view).
§Returns

Ok(Some(v)), Ok(None) when missing or empty, or Err on conversion failure.

Source

fn get_optional_list<T>(&self, name: &str) -> ConfigResult<Option<Vec<T>>>
where MultiValues: MultiValuesGetter<T>,

Gets an optional list with the same semantics as crate::Config::get_optional_list.

§Type parameters
  • T - Element type; requires MultiValues to implement MultiValuesGetter for T.
§Parameters
  • name - Configuration key.
§Returns

Ok(Some(vec)), Ok(None) when missing or empty, or Err on failure.

Source

fn contains_prefix(&self, prefix: &str) -> bool

Returns whether any key visible to this reader starts with prefix.

§Parameters
  • prefix - Key prefix to test (for a prefix view, keys are relative to that view).
§Returns

true if at least one matching key exists.

Source

fn iter_prefix<'a>( &'a self, prefix: &'a str, ) -> Box<dyn Iterator<Item = (&'a str, &'a Property)> + 'a>

Iterates (key, property) pairs for keys that start with prefix.

§Parameters
  • prefix - Key prefix filter.
§Returns

A boxed iterator over matching entries.

Source

fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = (&'a str, &'a Property)> + 'a>

Iterates all (key, property) pairs visible to this reader (same scope as Self::keys).

Source

fn is_null(&self, name: &str) -> bool

Returns true if the key exists and the property has no values (same as crate::Config::is_null).

Source

fn subconfig(&self, prefix: &str, strip_prefix: bool) -> ConfigResult<Config>

Extracts a subtree as a new Config (same semantics as crate::Config::subconfig; on a prefix view, prefix is relative to the view).

Source

fn deserialize<T>(&self, prefix: &str) -> ConfigResult<T>
where T: DeserializeOwned,

Deserializes the subtree at prefix with serde (same as crate::Config::deserialize; on a prefix view, prefix is relative).

Source

fn prefix_view(&self, prefix: &str) -> ConfigPrefixView<'_>

Creates a read-only prefix view; relative keys resolve under prefix.

Semantics match crate::Config::prefix_view and crate::ConfigPrefixView::prefix_view (nested prefix when called on a view).

§Parameters
  • prefix - Logical prefix; empty means the full configuration (same as root).
§Returns

A ConfigPrefixView borrowing this reader’s underlying crate::Config.

Provided Methods§

Source

fn get_or<T>(&self, name: &str, default: T) -> T
where MultiValues: MultiValuesFirstGetter<T>,

Gets a value or default if the key is missing or conversion fails (same as crate::Config::get_or).

Source

fn resolve_key(&self, name: &str) -> String

Resolves name into the canonical key path against the root crate::Config.

For a root crate::Config, this returns name unchanged. For a crate::ConfigPrefixView, this prepends the effective view prefix so callers can report root-relative key paths in diagnostics.

§Parameters
  • name - Relative or absolute key in the current reader scope.
§Returns

Root-relative key path string.

Source

fn get_string(&self, name: &str) -> ConfigResult<String>

Gets a string value, applying variable substitution when enabled.

§Parameters
  • name - Configuration key.
§Returns

The string after ${...} resolution, or a crate::ConfigError.

Source

fn get_string_or(&self, name: &str, default: &str) -> String

Gets a string value with substitution, or default if lookup or substitution fails.

§Parameters
  • name - Configuration key.
  • default - Fallback string when Self::get_string would error.
§Returns

The resolved string or a clone of default.

Source

fn get_string_list(&self, name: &str) -> ConfigResult<Vec<String>>

Gets all string values for name, applying substitution to each element when enabled.

§Parameters
  • name - Configuration key.
§Returns

A vector of resolved strings, or a crate::ConfigError.

Source

fn get_string_list_or(&self, name: &str, default: &[&str]) -> Vec<String>

Gets a string list with substitution, or copies default if lookup fails.

§Parameters
§Returns

The resolved list or default converted to owned Strings.

Source

fn get_optional_string(&self, name: &str) -> ConfigResult<Option<String>>

Gets an optional string with the same three-way semantics as crate::Config::get_optional_string.

§Parameters
  • name - Configuration key.
§Returns

Ok(None) if the key is missing or empty; Ok(Some(s)) with substitution applied; or Err if the value exists but cannot be read as a string.

Source

fn get_optional_string_list( &self, name: &str, ) -> ConfigResult<Option<Vec<String>>>

Gets an optional string list with per-element substitution when enabled.

§Parameters
  • name - Configuration key.
§Returns

Ok(None) if the key is missing or empty; Ok(Some(vec)) otherwise; or Err on conversion/substitution failure.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§