Struct Definition 

pub struct Definition {
    pub schema: String,
    pub name: String,
    pub version: String,
    pub package: String,
    pub inputs: Vec<InputDecl>,
    pub steps: Vec<StepDecl>,
    pub policy: PolicyDecl,
    pub limits: LimitsDecl,
    pub actionability: Option<Actionability>,
    pub screening: Option<Screening>,
}

A versioned, authored description of a recurring decision.

Fields

schema: String

name: String

version: String

MAJOR.MINOR.PATCH, each without leading zeros.

package: String

inputs: Vec<InputDecl>

steps: Vec<StepDecl>

policy: PolicyDecl

limits: LimitsDecl

actionability: Option<Actionability>

Version 2: provenance-conditional checks and actionable outcomes (spec 033, 3.1.1); omitted when unused.

screening: Option<Screening>

Optional screening contract (spec 035); omitted when unused.

Trait Implementations

impl Clone for Definition

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Definition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Definition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Document for Definition

const SCHEMA: &'static str = schema::DEFINITION

The schema string this document carries (spec 002, 3.2.1).

const LIMITS: ParseLimits = DEFINITION_V1

The limit set its bytes are scanned against (spec 002, 3.2.5).

fn schema(&self) -> &str

The value of the document’s own schema field.

fn parse(bytes: &[u8]) -> Result<Self, DocumentError>

Scan, deserialize and check the schema string.

fn record_digest(&self) -> Result<ContentDigest, CanonicalError>

sha256(SCHEMA || 0x00 || record canonical bytes) (spec 004, 3.1.6). Equal to the identity of an identified document.

fn canonical(&self) -> Result<Vec<u8>, CanonicalError>

The canonical bytes (spec 002, 3.3.1).

fn record_canonical(&self) -> Result<Vec<u8>, CanonicalError>

where Self: PartialEq,

The record canonical bytes (spec 004, 5.6): the canonical bytes, with finite fractional numbers written in shortest round-trip form.

impl Identified for Definition

type Id = DefinitionId

fn id(&self) -> Result<DefinitionId, CanonicalError>

sha256(SCHEMA || 0x00 || canonical bytes) (spec 002, 3.3.2).

impl JsonSchema for Definition

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 PartialEq for Definition

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Definition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Definition