Module

std::meta::module contains methods on the built-in Module type which represents a module in the source program. Note that this type represents a module generally, it isn't limited to only mod my_submodule { ... } declarations in the source program.

Methods

add_item

add_item

comptime fn add_item(self, item: Quoted) {}

^{_{Source code: noir_stdlib/src/meta/module.nr#L3-L5}}

Adds a top-level item (a function, a struct, a global, etc.) to the module. Adding multiple items in one go is also valid if the Quoted value has multiple items in it.
Note that the items are type-checked as if they are inside the module they are being added to.

name

name

comptime fn name(self) -> Quoted {}

^{_{Source code: noir_stdlib/src/meta/module.nr#L23-L25}}

Returns the name of the module.

functions

functions

comptime fn functions(self) -> [FunctionDefinition] {}

^{_{Source code: noir_stdlib/src/meta/module.nr#L18-L20}}

Returns each function in the module.

has_named_attribute

has_named_attribute

comptime fn has_named_attribute(self, name: Quoted) -> bool {}

^{_{Source code: noir_stdlib/src/meta/module.nr#L8-L10}}

Returns true if this module has a custom attribute with the given name.

is_contract

is_contract

comptime fn is_contract(self) -> bool {}

^{_{Source code: noir_stdlib/src/meta/module.nr#L13-L15}}

true if this module is a contract module (was declared via contract foo { ... }).