Struct Module 

pub struct Module {
    pub name: String,
    pub functions: Vec<Function>,
    pub structs: Vec<StructDef>,
    pub enums: Vec<EnumDef>,
    pub callbacks: Vec<CallbackDef>,
    pub listeners: Vec<ListenerDef>,
    pub errors: Option<ErrorDomain>,
    pub modules: Vec<Module>,
}

A module: a named namespace grouping related functions, types, callbacks, listeners, and an error domain.

Modules are the IDL’s unit of organization and map onto each target language’s natural grouping construct (a namespace, a submodule, a symbol prefix, and so on). They may nest through modules to mirror a package hierarchy.

Fields

name: String

Module name, used as a namespace segment and a symbol-prefix component in generated code (for example contacts).

functions: Vec<Function>

Free functions this module exports across the FFI boundary.

structs: Vec<StructDef>

Record (struct) types declared in this module.

enums: Vec<EnumDef>

Enum types, C-style or algebraic, declared in this module.

callbacks: Vec<CallbackDef>

Callback signatures this module’s functions and listeners can invoke.

listeners: Vec<ListenerDef>

Event listeners (subscribe and unsubscribe endpoints) this module exposes.

errors: Option<ErrorDomain>

Optional error domain: the named codes this module’s fallible functions report. None when the module declares no errors.

modules: Vec<Module>

Nested submodules, forming a tree that mirrors a package hierarchy.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Module

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Module

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Module

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Module

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Module