Struct Api 

pub struct Api {
    pub version: String,
    pub modules: Vec<Module>,
}

Top-level WeaveFFI API definition: the root of a parsed IDL document.

This is the value an entire .yml, .json, or .toml IDL file deserializes into (see crate::parse) and the single input the validator consumes. It pairs the schema version with the module forest.

Fields

version: String

IR schema version this document targets (for example 0.11.0). Validation rejects any value not listed in SUPPORTED_VERSIONS.

modules: Vec<Module>

Top-level modules that make up the API surface. Each is an independent namespace; modules may nest further through Module::modules.

Implementations

impl Api

pub fn for_each_type_ref<'a>(&'a self, f: &mut dyn FnMut(&'a TypeRef))

Call f on every type reference written anywhere in the document: parameters and returns of every function, interface member, and callback method, and the fields of every record, enum variant, and error code, in declaration order (outermost references only; use TypeRef::walk to reach nested ones).

Trait Implementations

impl Clone for Api

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 Api

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Api

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Api

impl JsonSchema for Api

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 Api

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Api

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 Api