Skip to main content

SettingKey

Enum SettingKey 

Source
pub enum SettingKey {
    DefaultTimeoutSecs,
    AgentDefaultsJsonErrors,
    RetryDefaultsMaxAttempts,
    RetryDefaultsInitialDelayMs,
    RetryDefaultsMaxDelayMs,
}
Expand description

Represents a valid configuration setting key.

Each variant maps to a specific path in the configuration file, with dot-notation used for nested values (e.g., agent_defaults.json_errors).

§Adding a New Setting

When adding a new setting, update the following locations:

  1. This enum - Add a new variant with doc comment
  2. SettingKey::ALL - Add the variant to the array
  3. SettingKey::as_str() - Return the dot-notation key string
  4. SettingKey::type_name() - Return the type name for display
  5. SettingKey::description() - Return a human-readable description
  6. SettingKey::default_value_str() - Return the default value as string
  7. SettingKey::value_from_config() - Extract value from GlobalConfig
  8. FromStr for SettingKey - Parse the key string to variant
  9. SettingValue - Add type variant if needed (e.g., String, Vec)
  10. SettingValue::parse_for_key() - Parse string to value with validation
  11. ConfigManager::set_setting() - Apply value to TOML document
  12. GlobalConfig (models.rs) - Add the field to the config struct
  13. CLI help text (cli.rs) - Update config set command’s long_about
  14. Tests - Add unit and integration tests for the new setting

Variants§

§

DefaultTimeoutSecs

Default timeout for API requests in seconds (default_timeout_secs)

§

AgentDefaultsJsonErrors

Whether to output errors as JSON by default (agent_defaults.json_errors)

§

RetryDefaultsMaxAttempts

Maximum number of retry attempts (retry_defaults.max_attempts)

§

RetryDefaultsInitialDelayMs

Initial delay between retries in milliseconds (retry_defaults.initial_delay_ms)

§

RetryDefaultsMaxDelayMs

Maximum delay cap in milliseconds (retry_defaults.max_delay_ms)

Implementations§

Source§

impl SettingKey

Source

pub const ALL: &'static [Self]

All available setting keys for enumeration.

Source

pub const fn as_str(&self) -> &'static str

Returns the dot-notation key string for this setting.

Source

pub const fn type_name(&self) -> &'static str

Returns the expected type name for this setting.

Source

pub const fn description(&self) -> &'static str

Returns a human-readable description of this setting.

Source

pub const fn default_value_str(&self) -> &'static str

Returns the default value for this setting as a string.

Source

pub const fn value_from_config(&self, config: &GlobalConfig) -> SettingValue

Extracts the current value for this setting from a GlobalConfig.

Trait Implementations§

Source§

impl Clone for SettingKey

Source§

fn clone(&self) -> SettingKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SettingKey

Source§

impl Debug for SettingKey

Source§

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

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

impl Display for SettingKey

Source§

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

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

impl Eq for SettingKey

Source§

impl FromStr for SettingKey

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for SettingKey

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SettingKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for SettingKey

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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 T
where 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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 T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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