Struct ContractSpec 

pub struct ContractSpec {
    pub version: String,
    pub description: Option<String>,
    pub owner: Option<String>,
    pub on_breach: OnBreach,
    pub allow_extra_fields: bool,
    pub fields: Vec<FieldContract>,
}

Available on crate feature contract only.

The contract: config block: a declarative, versioned schema + semantic contract for a pipeline’s output, enforced per page after transforms and quality checks and before the sink write.

Fields

version: String

Contract version, e.g. "1.0.0". Required and non-empty. Carried into breach errors, DLQ envelopes, and every export format so producers and consumers can pin the promise they agreed on. Recommendation: bump the major version on breaking changes (removing a field, narrowing a type) and the minor version on additive ones.

description: Option<String>

Human-readable description of the dataset this contract covers.

owner: Option<String>

Owning team or person (documentation metadata; carried into exports).

on_breach: OnBreach

Breach policy: fail (default) aborts the run, quarantine routes breaching records to the DLQ (a dlq: block is required), warn logs + counts but writes everything.

allow_extra_fields: bool

When false, a top-level key not declared in fields is a breach (extra_field). Default true — additive fields are allowed.

fields: Vec<FieldContract>

The promised top-level fields. Must be non-empty; names must be unique.

Trait Implementations

impl Clone for ContractSpec

fn clone(&self) -> ContractSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContractSpec

fn deserialize<__D>( __deserializer: __D, ) -> Result<ContractSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ContractSpec

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 Serialize for ContractSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.