Struct ContractEnvelope 

pub struct ContractEnvelope { /* private fields */ }

A strict semantic Contract plus namespaced, non-semantic ecosystem metadata.

Extensions are outside the canonical identities

The extension map is side-band data by design: contract_id and interface_id are computed over the Contract alone, so adding, removing, or editing an extension never moves a semantic identity (tests/artifact_identity.rs pins this, and docs/architecture.md’s identity table records it). Only the artifact identity over the envelope bytes (ArtifactKind::ContractEnvelopeJsonV1) covers extensions, because they are in those bytes.

Extension names are validated fail-closed: a reverse-domain namespace (dot-separated segments of lowercase letters, digits, and hyphens) followed by /v<integer> with no leading zero, e.g. org.candid-core.field-names/v1. Values are arbitrary JSON, bounded in aggregate by Limits::max_value_bytes.

The org.candid-core.field-names/v1 extension (issue #152)

The one extension this repository itself emits, via candid-core compile <path> --envelope: the field-name table as an array of [container, id, name] triples — named labels only, sorted, deduplicated — exactly the table TsNames::from_source_info builds from the provenance sidecar and the TypeScript runtime’s schemaFromContract consumes (hash-enforced, so a lying table fails closed there). The semantic Contract stores only authoritative label ids; this extension lets one self-describing document carry the names too, without touching the canonical format or its identities.

Implementations

impl ContractEnvelope

pub fn new(contract: Contract) -> Self

pub fn contract(&self) -> &Contract

pub fn extensions(&self) -> &BTreeMap<String, Value>

pub fn insert_extension( &mut self, name: impl Into<String>, value: Value, limits: &Limits, ) -> Result<(), ContractValidationError>

pub fn insert_extension_with_context( &mut self, name: impl Into<String>, value: Value, context: &RuntimeContext, ) -> Result<(), ContractValidationError>

pub fn validate(&self, limits: &Limits) -> Result<(), ContractValidationError>

pub fn validate_with_context( &self, context: &RuntimeContext, ) -> Result<(), ContractValidationError>

pub fn from_json_with_limits( input: &str, limits: &Limits, ) -> Result<Self, ContractJsonError>

Parse, validate, and canonicalize an envelope JSON document under caller-supplied limits.

pub fn from_json_with_context( input: &str, context: &RuntimeContext, ) -> Result<Self, ContractJsonError>

Bounded parse: max_input_bytes is enforced before decoding, and the nested Contract and the extension map are validated on one budget.

pub fn from_slice_with_limits( input: &[u8], limits: &Limits, ) -> Result<Self, ContractJsonError>

Bounded parse from bytes.

pub fn from_slice_with_context( input: &[u8], context: &RuntimeContext, ) -> Result<Self, ContractJsonError>

pub fn to_json_pretty_with_limits( &self, limits: &Limits, ) -> Result<String, ContractValidationError>

Serialize the envelope under caller-supplied limits.

pub fn to_json_pretty_with_context( &self, context: &RuntimeContext, ) -> Result<String, ContractValidationError>

Like Contract::to_json_pretty_with_context, this revalidates and charges the rendered length against max_canonicalization_work.

Trait Implementations

impl Clone for ContractEnvelope

fn clone(&self) -> ContractEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractEnvelope

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

Formats the value using the given formatter.

impl Eq for ContractEnvelope

impl PartialEq for ContractEnvelope

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ContractEnvelope

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 ContractEnvelope