# Struct cargo::util::config::key::ConfigKey

source ·

    pub struct ConfigKey {
        env: String,
        parts: Vec<(String, usize)>,
    }

Expand description

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.

## Fields§

§`env: String`§`parts: Vec<(String, usize)>`

## Implementations§

source§

### impl ConfigKey

source

#### pub fn new() -> ConfigKey

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

source

#### 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.

source

#### 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 corresponding toml key is appended with this `name` as-is and the corresponding env key is appended with `name` after transforming it to uppercase characters.

source

#### 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.

source

#### fn _push(&mut self, env: &str, config: &str)

source

#### pub fn pop(&mut self)

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

source

#### pub fn as_env_key(&self) -> &str

Returns the corresponding environment variable key for this configuration value.

source

#### pub(crate) fn parts(&self) -> impl Iterator<Item = &str>

Returns an iterator of the key parts as strings.

source

#### pub fn is_root(&self) -> bool

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

## Trait Implementations§

source§

### impl Clone for ConfigKey

source§

#### fn clone(&self) -> ConfigKey

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for ConfigKey

source§

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

Formats the value using the given formatter. Read more
source§

### impl Display for ConfigKey

source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl RefUnwindSafe for ConfigKey

§

### impl Send for ConfigKey

§

### impl Sync for ConfigKey

§

### impl Unpin for ConfigKey

§

### impl UnwindSafe for ConfigKey

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T> ToString for Twhere T: Display + ?Sized,

source§

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes