Struct Settings 

pub struct Settings {
    pub http_timeout: String,
    pub http_retries: u64,
    pub color: String,
    pub cache_ttl: String,
}

Settings that change how yt behaves. Each comes from the [settings] table of the global config, overridable by its environment variable.

Fields

http_timeout: String

How long a request may take

http_retries: u64

How often to retry a read on a network error or HTTP 408, 429 or 5xx

color: String

When to use color: auto, always or never

cache_ttl: String

How long cached project data stays valid

Implementations

impl Settings

pub const SETTINGS_PROPS: &'static [PropMeta] = <Self as ::usage_rs::config::Props>::PROPS

Every setting this struct declares, one entry per field, flattened groups included. The registry a build.rs used to generate, generated from the struct instead — there is no second declaration to keep in step.

pub const SETTINGS_REGISTRY: Registry

The registry over Self::SETTINGS_PROPS, for resolve, drift, and the layers.

pub const SETTINGS_SPEC: ConfigSpec

Metadata used only when lowering this declaration into a usage spec.

pub fn read(__usage_resolved: &Resolved) -> Result<Self, ReadErrors>

This resolution’s values, as the struct.

Every field is read before anything is returned, so the error is the whole list of what is wrong rather than the first thing found.

pub fn read_lossy(__usage_resolved: &Resolved) -> (Option<Self>, ReadErrors)

This resolution’s values, keeping every setting that reads.

Self::read is all or nothing, which leaves a CLI two moves when one field is bad: refuse to start, or fall back to a struct of declared defaults and lose the environment and every config file along with the offending value. Neither is a choice this crate should be making.

So: a field that will not read falls back to its own declared default and the rest keep what the merge gave them, with every failure returned alongside for the CLI to raise, log, or ignore as it sees fit. The errors are the same ::usage_config::ReadErrors Self::read returns, so a caller that decides a bad value is fatal has lost nothing by asking.

None only where a setting has no value and no declared default — a hole in the declaration rather than a bad value, and nothing to fall back to.

pub fn spec_kdl() -> String

The spec config block for these settings, as KDL.

What documents, JSON schema and completions read. A CLI deriving usage::Cli names this type in #[usage(config = ...)] instead of calling this, and its to_kdl carries the block.

impl Settings

pub fn http_timeout(&self) -> Result<Duration>

pub fn cache_ttl(&self) -> Result<Duration>

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl PartialEq for Settings

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

Equality operator ==.

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

Inequality operator !=.

impl Props for Settings

const PROPS: &'static [PropMeta]

This group’s settings, in declaration order.

const PROP_SPECS: &'static [PropSpec]

Spec-only metadata parallel to Props::PROPS.

impl StructuralPartialEq for Settings