Struct Choreography 

pub struct Choreography {
    pub name: Ident,
    pub namespace: Option<String>,
    pub roles: Vec<Role>,
    pub protocol: Protocol,
    pub attrs: HashMap<String, String>,
}

A complete choreographic protocol specification

Fields

name: Ident

Protocol name

namespace: Option<String>

Optional namespace for the protocol

roles: Vec<Role>

Participating roles

protocol: Protocol

The protocol specification

attrs: HashMap<String, String>

Metadata and attributes

Implementations

impl Choreography

pub fn qualified_name(&self) -> String

Get the qualified name of the choreography (namespace::name or just name)

pub fn validate(&self) -> Result<(), ValidationError>

Validate the choreography for correctness

Errors

Returns ValidationError if the choreography is invalid (unused roles, malformed protocol, duplicate/missing proof bundles, or missing capabilities).

pub fn language_tier_status(&self) -> LanguageTierStatus

pub fn authority_metatheory_status(&self) -> AuthorityMetatheoryStatus

pub fn get_attributes(&self) -> &HashMap<String, String>

Get choreography-level attributes/annotations

pub fn get_attributes_mut(&mut self) -> &mut HashMap<String, String>

Get mutable reference to choreography-level attributes

pub fn get_attribute(&self, key: &str) -> Option<&String>

Get a specific choreography attribute

pub fn set_attribute(&mut self, key: String, value: String)

Set a choreography attribute

pub fn remove_attribute(&mut self, key: &str) -> Option<String>

Remove a choreography attribute

pub fn has_attribute(&self, key: &str) -> bool

Check if choreography has a specific attribute

pub fn get_attribute_as<T>(&self, key: &str) -> Option<T>

where T: FromStr,

Get attribute as a specific type

pub fn get_attribute_as_bool(&self, key: &str) -> Option<bool>

Get attribute as boolean

pub fn clear_attributes(&mut self)

Clear all choreography attributes

pub fn attribute_count(&self) -> usize

Count of choreography attributes

pub fn attribute_keys(&self) -> Vec<&String>

Get all attribute keys

pub fn validate_required_attributes( &self, required_keys: &[&str], ) -> Result<(), Vec<String>>

Validate that required attributes are present

pub fn find_nodes_with_annotation(&self, key: &str) -> Vec<&Protocol>

Find all protocol nodes with a specific annotation

pub fn find_nodes_with_annotation_value( &self, key: &str, value: &str, ) -> Vec<&Protocol>

Find all protocol nodes with a specific annotation value

pub fn total_annotation_count(&self) -> usize

Count total annotations across the entire choreography

pub fn set_theorem_packs( &mut self, theorem_packs: &[TheoremPackDeclaration], ) -> Result<(), String>

Set theorem-pack declarations for this choreography.

pub fn theorem_packs(&self) -> Vec<TheoremPackDeclaration>

Get typed theorem-pack declarations.

pub fn set_required_theorem_packs( &mut self, required: &[String], ) -> Result<(), String>

Set protocol-required theorem packs.

pub fn required_theorem_packs(&self) -> Vec<String>

Get protocol-required theorem packs.

pub fn set_inferred_required_theorem_packs( &mut self, required: &[String], ) -> Result<(), String>

Set inferred protocol-required theorem packs.

pub fn inferred_required_theorem_packs(&self) -> Vec<String>

Get inferred protocol-required theorem packs.

pub fn set_role_sets( &mut self, role_sets: &[RoleSetDeclaration], ) -> Result<(), String>

Set role-set declarations for this choreography.

pub fn role_sets(&self) -> Vec<RoleSetDeclaration>

Get typed role-set declarations.

pub fn set_topologies( &mut self, topologies: &[TopologyDeclaration], ) -> Result<(), String>

Set topology declarations for this choreography.

pub fn topologies(&self) -> Vec<TopologyDeclaration>

Get typed topology declarations.

pub fn set_type_declarations( &mut self, decls: &[TypeDeclaration], ) -> Result<(), String>

Set nominal type declarations for this choreography.

pub fn type_declarations(&self) -> Vec<TypeDeclaration>

Get nominal type declarations.

pub fn set_effect_interface_declarations( &mut self, decls: &[EffectInterfaceDeclaration], ) -> Result<(), String>

Set nominal effect interface declarations for this choreography.

pub fn effect_interface_declarations(&self) -> Vec<EffectInterfaceDeclaration>

Get nominal effect interface declarations.

pub fn effect_contract_declarations(&self) -> Vec<EffectContractDeclaration>

Derive runtime-facing effect metadata from nominal effect declarations and protocol uses dependencies.

pub fn set_protocol_uses(&mut self, uses: &[String]) -> Result<(), String>

Set explicit protocol effect dependencies.

pub fn protocol_uses(&self) -> Vec<String>

Get explicit protocol effect dependencies.

pub fn set_region_declarations( &mut self, decls: &[RegionDeclaration], ) -> Result<(), String>

Set region declarations for this choreography.

pub fn region_declarations(&self) -> Vec<RegionDeclaration>

Get region declarations.

pub fn set_operation_declarations( &mut self, decls: &[OperationDeclaration], ) -> Result<(), String>

Set operation declarations for this choreography.

pub fn operation_declarations(&self) -> Vec<OperationDeclaration>

Get operation declarations.

pub fn set_guest_runtime_declarations( &mut self, decls: &[GuestRuntimeDeclaration], ) -> Result<(), String>

Set guest-runtime declarations for this choreography.

pub fn guest_runtime_declarations(&self) -> Vec<GuestRuntimeDeclaration>

Get guest-runtime declarations.

pub fn set_execution_profile_declarations( &mut self, decls: &[ExecutionProfileDeclaration], ) -> Result<(), String>

Set execution-profile declarations for this choreography.

pub fn execution_profile_declarations(&self) -> Vec<ExecutionProfileDeclaration>

Get execution-profile declarations.

pub fn set_protocol_execution_profiles( &mut self, profiles: &[String], ) -> Result<(), String>

Set protocol-selected execution profiles.

pub fn protocol_execution_profiles(&self) -> Vec<String>

Get protocol-selected execution profiles.

pub fn set_agreement_profile_declarations( &mut self, decls: &[AgreementProfileDeclaration], ) -> Result<(), String>

Set reusable agreement-profile declarations for this choreography.

pub fn agreement_profile_declarations(&self) -> Vec<AgreementProfileDeclaration>

Get reusable agreement-profile declarations.

Trait Implementations

impl Debug for Choreography

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

Formats the value using the given formatter.