Struct Settings 

pub struct Settings {
    pub api: SettingsApi,
    pub general: SettingsGeneral,
    pub ipc: SettingsIpc,
    pub logs: SettingsLogs,
    pub proxy: SettingsProxy,
    pub supervisor: SettingsSupervisor,
    pub tui: SettingsTui,
    pub web: SettingsWeb,
}

Every setting pitchfork has.

SETTINGS_PROPS, SETTINGS_REGISTRY, read, and spec_kdl are generated from these fields; the CLI’s emitted spec carries the config block through #[usage(config = ...)] on the root.

Fields

api: SettingsApi

general: SettingsGeneral

ipc: SettingsIpc

logs: SettingsLogs

proxy: SettingsProxy

supervisor: SettingsSupervisor

tui: SettingsTui

web: SettingsWeb

Implementations

impl Settings

pub const SETTINGS_PROPS: &'static [PropMeta] = <Self as ::usage_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 general_autostop_delay(&self) -> Duration

Get general.autostop_delay as Duration

pub fn general_interval(&self) -> Duration

Get general.interval as Duration

pub fn general_ready_delay(&self) -> Duration

Get general.ready_delay as Duration

pub fn ipc_connect_max_delay(&self) -> Duration

Get ipc.connect_max_delay as Duration

pub fn ipc_connect_min_delay(&self) -> Duration

Get ipc.connect_min_delay as Duration

pub fn ipc_rate_limit_window(&self) -> Duration

Get ipc.rate_limit_window as Duration

pub fn ipc_request_timeout(&self) -> Duration

Get ipc.request_timeout as Duration

pub fn logs_time_retention(&self) -> Duration

Get logs.time_retention as Duration

pub fn proxy_auto_start_timeout(&self) -> Duration

Get proxy.auto_start_timeout as Duration

pub fn supervisor_cron_check_interval(&self) -> Duration

Get supervisor.cron_check_interval as Duration

pub fn supervisor_file_watch_debounce(&self) -> Duration

Get supervisor.file_watch_debounce as Duration

pub fn supervisor_health_check_interval(&self) -> Duration

Get supervisor.health_check_interval as Duration

pub fn supervisor_health_cmd_timeout(&self) -> Duration

Get supervisor.health_cmd_timeout as Duration

pub fn supervisor_health_http_timeout(&self) -> Duration

Get supervisor.health_http_timeout as Duration

pub fn supervisor_health_port_timeout(&self) -> Duration

Get supervisor.health_port_timeout as Duration

pub fn supervisor_http_client_timeout(&self) -> Duration

Get supervisor.http_client_timeout as Duration

pub fn supervisor_log_flush_interval(&self) -> Duration

Get supervisor.log_flush_interval as Duration

pub fn supervisor_oneshot_timeout(&self) -> Duration

Get supervisor.oneshot_timeout as Duration

pub fn supervisor_ready_check_interval(&self) -> Duration

Get supervisor.ready_check_interval as Duration

pub fn supervisor_restart_delay(&self) -> Duration

Get supervisor.restart_delay as Duration

pub fn supervisor_stop_timeout(&self) -> Duration

Get supervisor.stop_timeout as Duration

pub fn supervisor_watch_interval(&self) -> Duration

Get supervisor.watch_interval as Duration

pub fn supervisor_watch_poll_interval(&self) -> Duration

Get supervisor.watch_poll_interval as Duration

pub fn tui_message_duration(&self) -> Duration

Get tui.message_duration as Duration

pub fn tui_refresh_rate(&self) -> Duration

Get tui.refresh_rate as Duration

pub fn tui_tick_rate(&self) -> Duration

Get tui.tick_rate as Duration

pub fn web_sse_poll_interval(&self) -> Duration

Get web.sse_poll_interval as Duration

impl Settings

pub fn supervisor_oneshot_wait(&self) -> OneshotWait

How long to wait for a oneshot daemon to finish.

supervisor.oneshot_timeout = "0" means no limit: a task’s natural end is its exit, and a long migration should not be called failed merely for outlasting a default. That is an absent deadline, not a very large one, so no task can outlive the substitute and be reported as timed out despite the setting promising otherwise.

pub fn general_ready_delay_secs(&self) -> Result<u64, String>

Resolve general.ready_delay as whole seconds.

The ready-check pipeline (RunOptions/IPC/supervisor) models the delay in whole seconds. Reject subsecond values that would otherwise be silently truncated to a zero delay by as_secs().

impl Settings

pub fn load() -> Self

Load settings from pitchfork.toml files, then overlay environment variables. Settings are loaded from all pitchfork.toml files in precedence order:

1. System-level: /etc/pitchfork/config.toml
2. User-level: ~/.config/pitchfork/config.toml
3. Project-level: pitchfork.toml files from root to current directory

Environment variables override all file-based settings.

The global settings() accessor resolves through Settings::resolve_from_dir so it can keep the provenance; this stays as the public one-shot entry point.

pub fn load_from_dir(start_dir: &Path) -> Self

Load settings for a specific project directory, then overlay environment variables.

This is used when operating on daemons from registered namespaces whose project settings may differ from those of the invoking process’s current directory.

pub fn parse_duration(s: &str) -> Option<Duration>

Parse a duration string (humantime format) to Duration

pub fn resolve_mise_bin(&self) -> Option<PathBuf>

Resolve the mise binary path.

If general.mise_bin is explicitly set, returns that path. Otherwise, searches well-known install locations:

• ~/.local/bin/mise
• ~/.cargo/bin/mise
• /usr/local/bin/mise
• /opt/homebrew/bin/mise

Returns None if mise cannot be found.

pub fn resolve_shell( &self, shell_is_explicit: bool, ) -> Result<Vec<String>, String>

Resolve the shell used for daemon run scripts, ready_cmd / health_cmd probes, lifecycle hooks and the log archive hook, split into a program and its arguments.

general.shell applies everywhere. On Windows it applies only when it was set explicitly (shell_is_explicit); a Windows machine that leaves it at its default uses general.windows_shell instead, because the sh that general.shell defaults to is not on a stock Windows PATH. crate::settings::resolve_shell supplies that flag from the origin of the merged value; it is a parameter here so the precedence can be tested without a resolution.

Err names the key whose value is empty or could not be split.

pub fn default_port_bump_attempts(&self) -> u32

Return supervisor.port_bump_attempts as u32, clamping out-of-range values to the schema default (10) and zero to 1.

This is the single source of truth for the fallback so that call-sites don’t each duplicate the hardcoded 10.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

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 Default for Settings

fn default() -> Self

The declared defaults, read the same way any other resolution is.

impl PartialEq for Settings

fn eq(&self, other: &Settings) -> 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