Struct ScenarioFile 

pub struct ScenarioFile {
    pub version: u32,
    pub scenario_name: Option<String>,
    pub category: Option<String>,
    pub description: Option<String>,
    pub defaults: Option<Defaults>,
    pub scenarios: Vec<Entry>,
}

A parsed v2 scenario file.

This is the top-level AST node produced by parse::parse. It captures the exact structure of the YAML input without resolving defaults, expanding packs, or compiling after-clauses.

Catalog metadata

The three optional fields scenario_name, category, and description mirror the v1 top-level metadata shape so the CLI catalog probe (sonda::scenarios::read_scenario_metadata) reads v1 and v2 files through the same Deserialize struct. The compiler pipeline itself (normalize → expand → compile_after → prepare) does not consume these fields — they are pure metadata, not compile input.

Fields

version: u32

Schema version. Must be 2.

scenario_name: Option<String>

Catalog display name (kebab-case). When present it overrides the filename-derived name in the CLI catalog probe. Pure metadata — ignored by every compiler phase.

category: Option<String>

Catalog category used by scenarios list --category <name> and catalog list --category <name>. Allowed values are enforced by the CLI CI validation (infrastructure, network, application, observability); the AST itself does not constrain the string. Pure metadata — ignored by every compiler phase.

description: Option<String>

One-line human-readable description surfaced by scenarios list / catalog list and scenarios show. Pure metadata — ignored by every compiler phase.

defaults: Option<Defaults>

Optional shared defaults inherited by all entries.

scenarios: Vec<Entry>

One or more scenario entries (inline signals or pack references).

Trait Implementations

impl Clone for ScenarioFile

fn clone(&self) -> ScenarioFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScenarioFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScenarioFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScenarioFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.