Enum SpikeError 

#[non_exhaustive]
pub enum SpikeError {
    Overlay(String),
    Materialize(String),
    Oniro(String),
    Segment(String),
    Timeout(String),
    ResourceCap(String),
    Protocol(String),
    Atune(Error),
    Io(Error),
}

An error from the oniro tuning spike harness.

The spike composes several fallible layers — TOML materialization, the oniro_cli handshake, and the atune study loop — so its error keeps the three apart rather than flattening them into strings a caller cannot match on.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Overlay(String)

The search-space overlay could not be parsed.

Materialize(String)

A trial configuration could not be materialized from the base config and the sampled values.

Oniro(String)

The oniro_cli (or mock) handshake failed: a non-zero exit, an output the contract does not permit, or a missing objective.

Segment(String)

A segmented trial could not be planned or run: a degenerate or unbounded SegmentPlan, a fidelity parameter that is not a step count, or a segment below the trainer’s learn floor (RungFloor).

Timeout(String)

A segment’s oniro process (or the eval after it) exceeded its per-segment timeout and was killed.

A wedged oniro process would otherwise block the whole study forever (run_segment waits on the child); this turns that hang into a failed trial the study loop can record and move past (docs/design/04-rl-and-oniro.md §A.4).

ResourceCap(String)

An explicit resource cap was exceeded.

Distinct from Timeout, which bounds work that had already started, and from Materialize, which means a configuration is malformed: this variant means a quantity — bytes of config text, concurrent trial processes, evaluation episodes — crossed a stated ceiling, so a caller can tell “too big” from “wrong” and a runaway input is refused rather than silently truncated to fit.

Protocol(String)

The multi-seed protocol and the rest of the configuration disagree.

The one case today: an Oniro scheduler with a multi-seed fan. Core sends aligned aggregate reports to the scheduler, but Oniro’s replicates produce distinct run-directory checkpoints while pause/fork recovery accepts one reference. Refusing avoids an ambiguous resume.

Atune(Error)

A study operation (atune) failed.

Io(Error)

An I/O operation failed.

Trait Implementations

impl Debug for SpikeError

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

Formats the value using the given formatter.

impl Display for SpikeError

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

Formats the value using the given formatter.

impl Error for SpikeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for SpikeError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SpikeError

fn from(source: Error) -> Self

Converts to this type from the input type.