Struct PlanBundle 

pub struct PlanBundle {
    pub schema: PlanBundleSchema,
    pub definition: Embedded<Definition>,
    pub execution_policy: Maybe<Embedded<ExecutionPolicy>>,
    pub calibrations: List<Embedded<CalibrationArtifact>, 0, 1024>,
    pub bindings: BTreeMap<Handle, Handle>,
    pub compile_report: CompileReport,
}

Fields

schema: PlanBundleSchema

definition: Embedded<Definition>

execution_policy: Maybe<Embedded<ExecutionPolicy>>

calibrations: List<Embedded<CalibrationArtifact>, 0, 1024>

bindings: BTreeMap<Handle, Handle>

compile_report: CompileReport

Implementations

impl PlanBundle

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

tagged_digest of the bundle’s canonical bytes (042 3.3): exactly the bytes Document::canonical produces, so a verifier that hashes canonical() reproduces it.

Trait Implementations

impl Clone for PlanBundle

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 PlanBundle

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlanBundle

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Document for PlanBundle

const SCHEMA: &'static str = "rustev.plan-bundle/1"

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

const LIMITS: ParseLimits = BUNDLE_LIMITS

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 canonical(&self) -> Result<Vec<u8>, CanonicalError>

The canonical bytes (spec 002, 3.3.1).

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

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

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

where Self: PartialEq,

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

impl JsonSchema for PlanBundle

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 PlanBundle

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PlanBundle

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 PlanBundle