Struct Require 

pub struct Require {
    pub ac_power: bool,
    pub idle: Option<String>,
    pub cpu_below: Option<f64>,
    pub network: bool,
}

Host-environment gate (#418 constraints.require). Fire only when the target host is in the required state. Sensed in-process by the agent (Win32), so it is runs_on: agent only — the backend cannot read a target host’s power/idle state (Schedule::validate rejects it on runs_on: backend, symmetric with when: { on }).

Evaluated at fire time as a skip-this-tick gate (NOT in Constraints::allows, which stays pure for preview): a reconcile cadence re-checks every minute (so it effectively defers until the state is met — the intended pairing); a calendar fire that lands while the state is unmet is simply missed, same as window. It is therefore a runtime gate and does not appear in preview.

Fields

ac_power: bool

Fire only while on AC power (skip on battery). Reads GetSystemPowerStatus; an unknown/unreadable status is treated as not-on-AC (fail-closed — a restrictive gate must not fire when it can’t confirm the condition). false (default) = no power requirement.

idle: Option<String>

Fire only when the active console session has had no keyboard / mouse input for at least this long (humantime, e.g. "10m") — “don’t run while the user is actively working”. Input-based (simpler than Task Scheduler’s CPU/disk-aware idle). A headless / disconnected console (no interactive user) trivially satisfies it. None (default) = no idle requirement. Parsed lazily; Schedule::validate rejects garbage at create time.

cpu_below: Option<f64>

Fire only when the whole-machine CPU usage is below this percent (0–100; e.g. 20.0 = “system CPU < 20%”) — “don’t run while the box is busy”. Reuses the agent’s host_perf system CPU% sample (sysinfo mean over cores), so the reading is up to one host_perf cadence old (default 60s) — fine as a “generally busy?” proxy, and more accurate than a fresh one-shot read (CPU% needs two samples). An unavailable sample (host_perf not warmed up yet, or stale) is treated as “not below” (fail-closed — a restrictive gate must not fire when it can’t confirm). None (default) = no CPU requirement. Schedule::validate rejects an out-of-range value at create time.

network: bool

Fire only when the host has internet connectivity (Windows GetNetworkConnectivityHint reports InternetAccess) — “don’t run until online” for jobs that download / phone home. A captive portal (ConstrainedInternetAccess), LAN-only (LocalAccess), or unknown/unreadable state is treated as offline (fail-closed) — a portal would just fail a download, so we hold the run. For VPN / SASE / app-specific conditions, use a custom script gate (separate slice). false (default) = no network requirement.

Implementations

impl Require

pub fn is_empty(&self) -> bool

skip_serializing_if helper for an embedded empty require.

pub fn min_idle(&self) -> Option<Duration>

Parsed minimum-idle duration (None = no idle requirement, or an unparseable value — validate rejects the latter at create time).

pub fn bad_idle(&self) -> Option<String>

First unparseable field for create-time rejection (mirrors Constraints::bad_skip_date).

Trait Implementations

impl Clone for Require

fn clone(&self) -> Require

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Require

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

Formats the value using the given formatter.

impl Default for Require

fn default() -> Require

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Require

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Require

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Require

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Require

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Require