Trait Contract 

pub trait Contract: Send + Sync {
    type Family: ContractFamily;
    type Category: EntityCategory;

    // Required methods
    fn family(&self) -> &Self::Family;
    fn version(&self) -> &SpecVersion;
    fn groups(&self) -> &[Group];
    fn entities(&self, group: &Group) -> &[Entity<Self::Category>];
    fn link_context(&self, opts: &Options) -> LinkContext;

    // Provided methods
    fn group_overview(&self, group: &Group) -> Option<&str> { ... }
    fn companions(&self) -> &[CompanionFile] { ... }
}

A loaded, resolved contract ready to render or serialize.

Parser crates implement this trait after parsing and resolving references. The sync API supports in-memory traversal during manual assembly.

Required Associated Types

type Family: ContractFamily

Contract family metadata and capabilities.

type Category: EntityCategory

Family-specific entity category type.

Required Methods

fn family(&self) -> &Self::Family

Returns the contract family identity for this loaded instance.

fn version(&self) -> &SpecVersion

Returns the parsed spec version for this contract instance.

fn groups(&self) -> &[Group]

Returns all groups in this contract (entities are queried per group).

fn entities(&self, group: &Group) -> &[Entity<Self::Category>]

Returns entities belonging to group.

fn link_context(&self, opts: &Options) -> LinkContext

Builds a LinkContext for cross-reference formatting under opts.

Provided Methods

fn group_overview(&self, group: &Group) -> Option<&str>

Returns optional overview prose for group, when the family provides it.

fn companions(&self) -> &[CompanionFile]

Returns parser-side companion files discovered for this contract.

Default empty; families with companion docs override. Convert to wire Companion via companion_files_to_stored.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors