Struct BindingModel 

pub struct BindingModel {
    pub prefix: String,
    pub version: String,
    pub modules: Vec<ModuleBinding>,
}

The whole API, normalized and lowered for code generation.

Fields

prefix: String

The C symbol prefix every emitted name is built from.

version: String

The IR schema version of the source Api.

modules: Vec<ModuleBinding>

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

Implementations

impl BindingModel

pub fn build(api: &ResolvedApi) -> Self

Build the model from a ResolvedApi. Every C symbol name starts with the API identity’s prefix, which is the same for the producer and every consumer of one library.

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 interface(&self, name: &str, current: &str) -> Option<&InterfaceBinding>

Find an interface anywhere in the API by its (possibly dot-qualified) resolved name, as carried by Ty::Interface. A bare name is looked up in current (the referencing module’s dot path) first.

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 checksum function, 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, C-style enum types and constants, error-domain types and code constants, and callback-interface vtable types.

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).

pub fn has_buffered_objects(&self) -> bool

true when any interface appears inside a buffered position (a record field, a collection element, an optional payload, a rich-enum field), so codecs need object-token support.

pub fn any_type(&self, pred: &dyn Fn(&Ty) -> bool) -> bool

Visit every boundary-crossing type in the API (callable and callback-method parameters and returns, iterator elements, record, variant, and error payload fields), recursing into composites, and return whether any satisfies pred. Backends use this to decide which runtime helpers a given API actually needs.

Trait Implementations

impl Clone for BindingModel

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 BindingModel

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

Formats the value using the given formatter.

impl Eq for BindingModel

impl PartialEq for BindingModel

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BindingModel