Struct ModuleBinding 

pub struct ModuleBinding {
    pub name: String,
    pub checksum: Option<u64>,
    pub segments: Vec<String>,
    pub path: String,
    pub dot_path: String,
    pub doc: Option<String>,
    pub error: Option<ErrorBinding>,
    pub enums: Vec<EnumBinding>,
    pub structs: Vec<StructBinding>,
    pub interfaces: Vec<InterfaceBinding>,
    pub callback_interfaces: Vec<CallbackInterfaceBinding>,
    pub functions: Vec<FnBinding>,
}

One module, flattened with its underscore-joined symbol path.

Fields

name: String

The module name (its final path segment).

checksum: Option<u64>

The contract checksum (crate::checksum::module_checksum) of a top-level module; None for nested modules, which are covered by their root’s checksum.

segments: Vec<String>

Path segments from the root (e.g. ["outer", "inner"]).

path: String

Underscore-joined path used as the C symbol segment (e.g. outer_inner).

dot_path: String

Dot-joined path used to qualify cross-module type names (e.g. outer.inner).

doc: Option<String>

The module’s doc comment when the IDL records one, else the doc of the first documented function in the module.

error: Option<ErrorBinding>

The error domain in effect for this module’s throwing functions: its own domain, the nearest ancestor’s, or None when no domain is in scope (in which case validation has rejected any throws here).

enums: Vec<EnumBinding>

Enums declared in this module, fully lowered.

structs: Vec<StructBinding>

Structs declared in this module, fully lowered.

interfaces: Vec<InterfaceBinding>

Interfaces declared in this module, fully lowered.

callback_interfaces: Vec<CallbackInterfaceBinding>

Callback interfaces declared in this module, fully lowered.

functions: Vec<FnBinding>

Functions declared in this module, fully lowered.

Implementations

impl ModuleBinding

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

Find a callback interface declared in this module by name.

pub fn is_empty(&self) -> bool

True when this module declares no API surface at all.

pub fn declares_error(&self) -> bool

True when this module declares its own error domain (as opposed to inheriting one from an ancestor).

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

Every callable in this module: free functions, then each interface’s constructors, methods, and statics.

pub fn has_async(&self) -> bool

true when any callable in this module is async.

pub fn has_iterators(&self) -> bool

true when any callable in this module returns an iterator.

Trait Implementations

impl Clone for ModuleBinding

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 ModuleBinding

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

Formats the value using the given formatter.

impl Eq for ModuleBinding

impl PartialEq for ModuleBinding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModuleBinding