Struct cargo::util::config::ConfigKey

pub struct ConfigKey { /* fields omitted */ }

Key for a configuration variable.

This type represents a configuration variable that we’re looking up in Cargo’s configuration. This structure simultaneously keeps track of a corresponding environment variable name as well as a TOML config name. The intention here is that this is built up and torn down over time efficiently, avoiding clones and such as possible.

Implementations

impl ConfigKey

pub fn new() -> ConfigKey

Creates a new blank configuration key which is ready to get built up by using push and push_sensitive.

pub fn from_str(key: &str) -> ConfigKey

Creates a ConfigKey from the key specified.

The key specified is expected to be a period-separated toml configuration key.

pub fn push(&mut self, name: &str)

Pushes a new sub-key on this ConfigKey. This sub-key should be equivalent to accessing a sub-table in TOML.

Note that this considers name to be case-insensitive, meaning that the corrseponding toml key is appended with this name as-is and the corresponding env key is appended with name after transforming it to uppercase characters.

pub fn push_sensitive(&mut self, name: &str)

Performs the same function as push except that the corresponding environment variable does not get the uppercase letters of name but instead name is pushed raw onto the corresponding environment variable.

pub fn pop(&mut self)

Rewinds this ConfigKey back to the state it was at before the last push method being called.

pub fn as_env_key(&self) -> &str

Returns the corresponding environment variable key for this configuration value.

pub fn is_root(&self) -> bool

Returns whether or not this is a key for the root table.

Trait Implementations

impl Clone for ConfigKey

fn clone(&self) -> ConfigKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigKey

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

Formats the value using the given formatter.

impl Display for ConfigKey

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

Formats the value using the given formatter.