Struct Model 

pub struct Model {
    pub identity: Identity,
    pub version: String,
    pub modules: Vec<ModuleBinding>,
    pub types: TypeIndex,
}

The whole API, validated and lowered for code generation.

Built once per run by validate; every generator renders from it alone.

Fields

identity: Identity

The library’s identity: its name, C symbol prefix, native library name, and package metadata.

version: String

The IR schema version of the source document.

modules: Vec<ModuleBinding>

Modules in depth-first pre-order, each carrying its joined symbol path.

types: TypeIndex

Every user type name, mapped to its declaration.

Implementations

impl Model

pub fn resolve(&self, ty: &TypeRef) -> Ty

Resolve a written type reference against this model’s declarations. A name no declaration provides resolves to a Ty::Record (see assume_valid).

pub fn prefix(&self) -> &str

The C symbol prefix every emitted name starts with.

pub fn roots(&self) -> impl Iterator<Item = &ModuleBinding>

The top-level modules (those with a single path segment), in order.

pub fn children<'a>( &'a self, parent: &'a ModuleBinding, ) -> impl Iterator<Item = &'a ModuleBinding> + 'a

The direct submodules of parent, in declaration order. Backends that render nested namespaces recurse with this instead of re-walking the IR tree.

pub fn functions(&self) -> impl Iterator<Item = (&ModuleBinding, &FnBinding)>

Iterate every function across all modules, paired with its module.

pub fn callables(&self) -> impl Iterator<Item = (&ModuleBinding, &FnBinding)>

Iterate every callable (free functions and interface members) across all modules, paired with its module.

pub fn callback_interfaces( &self, ) -> impl Iterator<Item = (&ModuleBinding, &CallbackInterfaceBinding)>

Iterate every callback interface across all modules, paired with its module.

pub fn owner(&self, name: &str) -> &ModuleBinding

The module declaring the user type name.

Panics

Panics when name isn’t declared, which validation rules out for every name a Ty carries.

pub fn interface(&self, name: &str) -> &InterfaceBinding

The interface named name, as carried by Ty::Interface.

Panics

Panics when no interface has that name.

pub fn callback_interface(&self, name: &str) -> &CallbackInterfaceBinding

The callback interface named name, as carried by Ty::CallbackInterface.

Panics

Panics when no callback interface has that name.

pub fn enumeration(&self, name: &str) -> &EnumBinding

The enum (C-style or rich) named name, as carried by Ty::Enum and Ty::RichEnum.

Panics

Panics when no enum has that name.

pub fn error_domain(&self, module: &ModuleBinding) -> Option<&ErrorBinding>

The error domain in scope for module’s throwing functions: its own, else the nearest ancestor’s, else None (in which case validation has rejected any throws there).

pub fn c_symbols(&self) -> Vec<(String, String)>

Every C identifier the library’s ABI declares, paired with a human-readable description of the declaration that owns it, in declaration order. Validation rejects an API in which two entries share an identifier.

Covers the runtime surface (RUNTIME_SYMBOLS), each top-level module’s contract table function and the C header’s checker for it, every callable’s symbols (sync entry point, async launcher and completion type, iterator launcher, type, _next, and _destroy), interface types with their _clone and _destroy, enum types and constants (and a rich enum’s tag type), error-domain types and code constants, callback-interface vtable types, and what the C value-buffer helper header declares per user type: the struct of every record, rich enum, and error code with fields (ErrorCodeBinding::payload_tag), each with its VALUE_CODECS. (The header’s list, map, and optional shapes fall in RESERVED_SYMBOL_FAMILIES.)

pub fn has_async(&self) -> bool

true when any callable anywhere in the API is async.

pub fn has_iterators(&self) -> bool

true when any callable anywhere in the API returns an iterator.

pub fn has_callback_interfaces(&self) -> bool

true when the API declares any callback interface.

pub fn has_interfaces(&self) -> bool

true when the API declares any interface.

pub fn has_buffers(&self) -> bool

true when any type anywhere in the API crosses the ABI as a value buffer (records, rich enums, optionals, lists, maps, error payloads).

Trait Implementations

impl Clone for Model

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 Model

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

Formats the value using the given formatter.

impl Eq for Model

impl PartialEq for Model

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Model