Enum SpecDocument 

#[non_exhaustive]
pub enum SpecDocument {
    PlannerRun(PlannerRunSpec),
    RateBackend(RateBackend),
    CompressionBackend(CompressionBackend),
}

Universal top-level spec document.

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.

PlannerRun(PlannerRunSpec)

Planner-run configuration document.

RateBackend(RateBackend)

Standalone rate-backend document.

CompressionBackend(CompressionBackend)

Standalone compression-backend document.

Implementations

impl SpecDocument

pub fn to_binary(&self) -> Vec<u8>

Encode this document in the versioned binary document envelope.

pub fn parse_json_value(value: &Value, base_dir: &Path) -> SpecResult<Self>

Parse a canonical JSON document from a raw JSON value.

pub fn parse_json_value_staged( value: &Value, base_dir: &Path, ) -> SpecResult<ParsedSpecDocument>

Parse a canonical JSON document and return the parsed-stage wrapper.

pub fn from_binary(bytes: &[u8], base_dir: &Path) -> SpecResult<Self>

Decode a binary spec document.

pub fn from_binary_staged( bytes: &[u8], base_dir: &Path, ) -> SpecResult<ParsedSpecDocument>

Decode a binary spec document and return the parsed-stage wrapper.

pub fn validate_in( &self, env: &SpecEnvironment, ) -> SpecResult<ValidatedSpecDocument>

Validate this top-level document in the supplied environment.

pub fn validate(&self) -> SpecResult<ValidatedSpecDocument>

Validate this top-level document using the default compilation environment.

pub fn compile_in( &self, env: &SpecEnvironment, ) -> SpecResult<CompiledSpecDocument>

Validate and compile this top-level document in the supplied environment.

pub fn compile(&self) -> SpecResult<CompiledSpecDocument>

Validate and compile this top-level document using the default environment.

pub fn kind_str(&self) -> &'static str

Stable canonical kind name (matches the document’s "kind" JSON field).

Trait Implementations

impl CanonicalJson for SpecDocument

fn to_canonical_json_value(&self) -> SpecResult<Value>

Serialize this value into canonical JSON value form.

fn to_canonical_json(&self) -> SpecResult<String>

Serialize this value into deterministic canonical JSON text.

impl Clone for SpecDocument

fn clone(&self) -> SpecDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.