Struct RunOptions 

pub struct RunOptions {

    pub id: DaemonId,
    pub cmd: Vec<String>,
    pub run: Option<String>,
    pub force: bool,
    pub shell_pid: Option<u32>,
    pub dir: Dir,
    pub autostop: bool,
    pub cron_schedule: Option<String>,
    pub cron_retrigger: Option<CronRetrigger>,
    pub cron_immediate: Option<bool>,
    pub retry: Retry,
    pub retry_count: u32,
    pub ready_delay: Option<u64>,
    pub ready_output: Option<ReadyOutput>,
    pub ready_http: Option<ReadyHttp>,
    pub ready_port: Option<ReadyPort>,
    pub ready_cmd: Option<ReadyCmd>,
    pub health_cmd: Option<HealthCmd>,
    pub health_http: Option<HealthHttp>,
    pub health_port: Option<HealthPort>,
    pub port: Option<PortConfig>,
    pub wait_ready: bool,
    pub depends: Vec<DaemonId>,
    pub env: Option<IndexMap<String, String>>,
    pub deferred_template_context: Option<String>,
    pub watch: Vec<String>,
    pub watch_mode: WatchMode,
    pub watch_base_dir: Option<PathBuf>,
    pub mise: Option<bool>,
    pub mise_bin: Option<PathBuf>,
    pub slug: Option<String>,
    pub proxy: Option<bool>,
    pub user: Option<String>,
    pub memory_limit: Option<MemoryLimit>,
    pub cpu_limit: Option<CpuLimit>,
    pub stop_signal: Option<StopConfig>,
    pub archive_hook: Option<String>,
    pub log_format: Option<String>,
    pub on_output_hook: Option<OnOutputHook>,
    pub pty: Option<bool>,
    pub replaces_saved_record: bool,
    pub oneshot: bool,
    pub oneshot_wait: Option<OneshotWait>,
    pub on_directory_enter: bool,
    pub proxy_idle_timeout_ms: Option<u64>,
    pub cron_started: bool,
    pub no_shell: bool,
    pub replaces_ready_checks: bool,
    pub requested_by_client: bool,
}

Fields

id: DaemonId

cmd: Vec<String>

run: Option<String>

Original shell command string (from config run), passed verbatim to the shell. Falls back to joining cmd when None (e.g. ad-hoc pitchfork run -- cmd args).

force: bool

shell_pid: Option<u32>

dir: Dir

autostop: bool

cron_schedule: Option<String>

cron_retrigger: Option<CronRetrigger>

cron_immediate: Option<bool>

retry: Retry

retry_count: u32

ready_delay: Option<u64>

ready_output: Option<ReadyOutput>

ready_http: Option<ReadyHttp>

ready_port: Option<ReadyPort>

ready_cmd: Option<ReadyCmd>

health_cmd: Option<HealthCmd>

health_http: Option<HealthHttp>

health_port: Option<HealthPort>

port: Option<PortConfig>

wait_ready: bool

depends: Vec<DaemonId>

env: Option<IndexMap<String, String>>

deferred_template_context: Option<String>

Template context for a run command left unrendered for mise x, which is started with it in PITCHFORK_TEMPLATE_CONTEXT. Kept apart from env so a variable of that name the user configured stays theirs.

watch: Vec<String>

watch_mode: WatchMode

watch_base_dir: Option<PathBuf>

mise: Option<bool>

Whether to use mise for this daemon (None = inherit global general.mise setting).

Schema compatibility note

See Daemon::mise for downgrade implications when this field is None.

mise_bin: Option<PathBuf>

The mise binary to wrap the command with, from the daemon’s project settings (general.mise_bin). Resolved by the client, because the supervisor is long-lived and may have been started from a different directory. None falls back to the supervisor’s resolve_mise_bin.

slug: Option<String>

Optional stable slug alias for this daemon.

proxy: Option<bool>

Whether to proxy this daemon (None = inherit global proxy.enable setting).

user: Option<String>

Unix user to run this daemon as.

memory_limit: Option<MemoryLimit>

Memory limit for the daemon process (e.g. “50MB”, “1GiB”)

cpu_limit: Option<CpuLimit>

CPU usage limit as a percentage (e.g. 80 for 80%, 200 for 2 cores)

stop_signal: Option<StopConfig>

Unix signal to send for graceful shutdown (default: SIGTERM)

archive_hook: Option<String>

Archive hook command invoked before retention prunes this daemon’s logs.

log_format: Option<String>

Log format for this daemon: json, logfmt, auto, or text.

on_output_hook: Option<OnOutputHook>

Hook triggered when the daemon produces matching output

pty: Option<bool>

Allocate a pseudo-terminal for the daemon process.

replaces_saved_record: bool

This start describes the daemon in full, so the configuration fields it leaves unset are cleared from the saved record instead of kept. Set by every start except a restart of an ad-hoc daemon, which carries only part of its record.

False by default so that a request from an older client, which does not send it, keeps merging into the record as it always did.

oneshot: bool

Run-to-completion task rather than a long-running service.

oneshot_wait: Option<OneshotWait>

How long to wait for a oneshot to finish, already resolved from the project’s supervisor.oneshot_timeout.

Resolved by the client and carried on the request because the supervisor is long-lived and may have started in another directory, so its own settings() would not see the project’s value. None leaves the supervisor to fall back to whatever it can resolve.

on_directory_enter: bool

This start came from entering a directory rather than from a person asking for it, so a completed oneshot is left alone. Decided by the supervisor because only it holds authoritative state: the state file lags it by up to the flush interval, which is exactly the window a second directory entry lands in.

proxy_idle_timeout_ms: Option<u64>

The proxy is starting this daemon, and it may be stopped after this many milliseconds without proxy activity. None for every other start, which is what makes such a start explicit. Carried over by restarts (retry, file watch), which continue the same ownership.

cron_started: bool

The cron watcher is starting this run, so a successful spawn is what Daemon::last_cron_run records.

Set only by the watcher’s own call. A retry, file-watch or manual restart of a scheduled daemon carries the daemon’s cron_schedule but not this, because the schedule did not ask for it.

no_shell: bool

Start cmd directly, without a shell: the config’s run was an array. run is None then, since there is no command line.

replaces_ready_checks: bool

This start’s ready checks are the daemon’s only ones: those it leaves unset are cleared from the record instead of kept. Set by an ad-hoc restart given readiness flags, which replace how it was waited for.

Appended after no_shell for the positional IPC encoding.

requested_by_client: bool

Set by the supervisor on a start a client asked for over IPC; never sent. See Daemon::scheduled_from_config.

Trait Implementations

impl Clone for RunOptions

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 RunOptions

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

Formats the value using the given formatter.

impl Default for RunOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.