Struct Module 

pub struct Module(pub DefaultKey);

A wrapper around an ECS handle into the Context.

Tuple Fields

0: DefaultKey

Implementations

impl Module

pub fn new(context: &mut Context<'_>, kind: Kind) -> Module

Return a new module of a specific kind.

pub fn get_kind(&self, context: &Context<'_>) -> Kind

Get this module’s Kind.

pub fn function_iter(&self, context: &Context<'_>) -> FunctionIterator

Return an iterator over each of the Functions in this module.

pub fn add_global_variable( &self, context: &mut Context<'_>, call_path: Vec<String>, const_val: GlobalVar, )

Add a global variable value to this module.

pub fn new_unique_global_var( &self, context: &mut Context<'_>, name: String, local_type: Type, initializer: Option<Constant>, mutable: bool, ) -> GlobalVar

Add a value to the module global storage, by forcing the name to be unique if needed.

Will use the provided name as a hint and eventually rename it to guarantee insertion.

pub fn get_global_variable( &self, context: &Context<'_>, call_path: &Vec<String>, ) -> Option<GlobalVar>

Get a named global variable from this module, if found.

pub fn lookup_global_variable_name( &self, context: &Context<'_>, global: &GlobalVar, ) -> Option<String>

Lookup global variable name.

pub fn add_config( &self, context: &mut Context<'_>, name: String, content: ConfigContent, )

Add a config value to this module.

pub fn get_config<'a>( &self, context: &'a Context<'_>, name: &str, ) -> Option<&'a ConfigContent>

Get a named config content from this module, if found.

pub fn add_storage_key( &self, context: &mut Context<'_>, path: String, storage_key: StorageKey, )

Add a storage key value to this module.

pub fn get_storage_key<'a>( &self, context: &'a Context<'_>, path: &str, ) -> Option<&'a StorageKey>

Get a storage key with the given path from this module, if found.

pub fn lookup_storage_key_path<'a>( &self, context: &'a Context<'_>, storage_key: &StorageKey, ) -> Option<&'a str>

Lookup storage key path.

pub fn remove_function(&self, context: &mut Context<'_>, function: &Function)

Removed a function from the module. Returns true if function was found and removed.

Use with care! Be sure the function is not an entry point nor called at any stage.

pub fn iter_configs<'a>( &'a self, context: &'a Context<'_>, ) -> impl Iterator<Item = &'a ConfigContent> + 'a

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 Hash for Module

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 PassScope for Module

fn get_arena_idx(&self) -> DefaultKey

impl Copy for Module

impl Eq for Module

impl StructuralPartialEq for Module