Struct RunnerConfig 

#[non_exhaustive]
pub struct RunnerConfig {
    pub overall_timeout: Duration,
    pub initial_interval: Duration,
    pub max_interval: Duration,
    pub initial_delay: Duration,
    pub attempt_timeout: Duration,
    pub direction: Direction,
    pub once: bool,
    pub schedule: Schedule,
    pub success_threshold: u32,
    pub jitter: bool,
}

Knobs controlling how a Runner schedules and bounds probes.

Construct with RunnerConfig::default and chain the builder methods to override individual fields. All durations are best-effort: in-flight probes can overshoot the overall deadline by up to attempt_timeout because a running probe is not interrupted mid-attempt.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

overall_timeout: Duration

Wall-clock budget for the entire run, measured from the moment Runner::run is awaited (after initial_delay).

initial_interval: Duration

First retry interval after a failed probe. Each subsequent failure doubles the interval, capped at max_interval.

max_interval: Duration

Upper bound on the exponential backoff between retries.

initial_delay: Duration

Delay before the first probe fires.

attempt_timeout: Duration

Per-attempt timeout for one full probe (DNS, TCP, handshake, query).

direction: Direction

Whether the readiness condition is normal or inverted.

once: bool

When true, only one attempt is made per target. No retry loop.

schedule: Schedule

Whether probes run in parallel or sequentially.

success_threshold: u32

Number of consecutive successful attempts required before a target is considered satisfied. Default is 1. Higher values protect against flapping services that briefly return ready then fail.

jitter: bool

When true, randomized jitter is applied to retry intervals to avoid thundering-herd lockstep across parallel runs. Default is true.

Implementations

impl RunnerConfig

pub const DEFAULT_OVERALL_TIMEOUT: Duration

Default total wall-clock budget for a Runner::run call.

pub const DEFAULT_INITIAL_INTERVAL: Duration

Default first retry interval after a failed probe.

pub const DEFAULT_MAX_INTERVAL: Duration

Default upper bound on exponential backoff.

pub const DEFAULT_INITIAL_DELAY: Duration = Duration::ZERO

Default delay before the first probe (none).

pub const DEFAULT_ATTEMPT_TIMEOUT: Duration

Default per-attempt timeout.

pub const DEFAULT_SUCCESS_THRESHOLD: u32 = 1

Default consecutive-success threshold.

pub const MIN_INTERVAL: Duration

Floor applied to interval and attempt-timeout to avoid 0-duration spin.

impl RunnerConfig

pub const fn timeout(self, d: Duration) -> Self

Sets RunnerConfig::overall_timeout.

pub const fn interval(self, d: Duration) -> Self

Sets RunnerConfig::initial_interval.

pub const fn max_interval(self, d: Duration) -> Self

Sets RunnerConfig::max_interval.

pub const fn initial_delay(self, d: Duration) -> Self

Sets RunnerConfig::initial_delay.

pub const fn attempt_timeout(self, d: Duration) -> Self

Sets RunnerConfig::attempt_timeout.

pub const fn reverse(self, v: bool) -> Self

Selects Direction::Reverse when v is true, otherwise Direction::Wait.

pub const fn once(self, v: bool) -> Self

Sets RunnerConfig::once.

pub const fn sequential(self, v: bool) -> Self

Selects Schedule::Sequential when v is true, otherwise Schedule::Parallel.

pub const fn success_threshold(self, n: u32) -> Self

Sets RunnerConfig::success_threshold. Clamps zero to one.

pub const fn jitter(self, v: bool) -> Self

Sets RunnerConfig::jitter.

Trait Implementations

impl Clone for RunnerConfig

fn clone(&self) -> RunnerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunnerConfig

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

Formats the value using the given formatter.

impl Default for RunnerConfig

fn default() -> Self

Returns the “default value” for a type.