Struct move_model::model::ModuleEnv

pub struct ModuleEnv<'env> {
    pub env: &'env GlobalEnv,
    /* private fields */
}

Represents a module environment.

Fields

env: &'env GlobalEnv

Reference to the outer env.

Implementations

impl<'env> ModuleEnv<'env>

pub fn get_id(&self) -> ModuleId

Returns the id of this module in the global env.

pub fn get_name(&'env self) -> &'env ModuleName

Returns the name of this module.

pub fn matches_name(&self, name: &str) -> bool

Returns true if either the full name or simple name of this module matches the given string

pub fn get_loc(&'env self) -> Loc

Returns the location of this module.

pub fn get_attributes(&self) -> &[Attribute]

Returns the attributes of this module.

pub fn get_full_name_str(&self) -> String

Returns full name as a string.

pub fn get_identifier(&'env self) -> Identifier

Returns the VM identifier for this module

pub fn is_script_module(&self) -> bool

Returns true if this is a module representing a script.

pub fn is_target(&self) -> bool

Returns true of this module is target of compilation. A non-target module is a dependency only but not explicitly requested to process.

pub fn get_source_path(&self) -> &OsStr

Returns the path to source file of this module.

pub fn get_dependencies(&self) -> Vec<ModuleId>

Return the set of language storage ModuleId’s that this module’s bytecode depends on (including itself), friend modules are excluded from the return result.

pub fn get_friends(&self) -> Vec<ModuleId>

Return the set of language storage ModuleId’s that this module declares as friends

pub fn get_using_modules(&self, include_specs: bool) -> BTreeSet<ModuleId>

Returns the set of modules that use this one.

pub fn get_used_modules(&self, include_specs: bool) -> BTreeSet<ModuleId>

Returns the set of modules this one uses.

pub fn get_friend_modules(&self) -> BTreeSet<ModuleId>

Returns the set of modules this one declares as friends.

pub fn is_transitive_dependency(&self, module_id: ModuleId) -> bool

Returns true if the given module is a transitive dependency of this one. The transitive dependency set contains this module and all directly or indirectly used modules (without spec usage).

pub fn get_doc(&self) -> &str

Returns documentation associated with this module.

pub fn get_spec_block_infos(&self) -> &[SpecBlockInfo]

Returns spec block documentation infos.

pub fn symbol_pool(&self) -> &SymbolPool

Shortcut for accessing the symbol pool.

pub fn get_verified_module(&'env self) -> &'env CompiledModule

Gets the underlying bytecode module.

pub fn find_named_constant(
    &'env self,
    name: Symbol
) -> Option<NamedConstantEnv<'env>>

Gets a NamedConstantEnv in this module by name

pub fn get_named_constant(
    &'env self,
    id: NamedConstantId
) -> NamedConstantEnv<'env>

Gets a NamedConstantEnv in this module by the constant’s id

pub fn into_named_constant(self, id: NamedConstantId) -> NamedConstantEnv<'env>

Gets a NamedConstantEnv by id

pub fn get_named_constant_count(&self) -> usize

Gets the number of named constants in this module.

pub fn get_named_constants(
    &'env self
) -> impl Iterator<Item = NamedConstantEnv<'env>>

Returns iterator over NamedConstantEnvs in this module.

pub fn into_named_constants(
    self
) -> impl Iterator<Item = NamedConstantEnv<'env>>

Returns an iterator over NamedConstantEnvs in this module.

pub fn find_function(&self, name: Symbol) -> Option<FunctionEnv<'env>>

Gets a FunctionEnv in this module by name.

pub fn get_function(&'env self, id: FunId) -> FunctionEnv<'env>

Gets a FunctionEnv by id.

pub fn into_function(self, id: FunId) -> FunctionEnv<'env>

Gets a FunctionEnv by id.

pub fn get_function_count(&self) -> usize

Gets the number of functions in this module.

pub fn get_functions(&'env self) -> impl Iterator<Item = FunctionEnv<'env>>

Returns iterator over FunctionEnvs in this module.

pub fn into_functions(self) -> impl Iterator<Item = FunctionEnv<'env>>

Returns iterator over FunctionEnvs in this module.

pub fn get_used_function(&self, idx: FunctionHandleIndex) -> FunctionEnv<'_>

Gets FunctionEnv for a function used in this module, via the FunctionHandleIndex. The returned function might be from this or another module.

pub fn try_get_function_id(&self, idx: FunctionDefinitionIndex) -> Option<FunId>

Gets the function id from a definition index.

pub fn get_function_def_idx(&self, fun_id: FunId) -> FunctionDefinitionIndex

Gets the function definition index for the given function id. This is always defined.

pub fn find_struct(&self, name: Symbol) -> Option<StructEnv<'_>>

Gets a StructEnv in this module by name.

pub fn find_struct_by_identifier(
    &self,
    identifier: Identifier
) -> Option<StructId>

Gets a StructEnv in this module by identifier

pub fn get_struct_id(&self, idx: StructDefinitionIndex) -> StructId

Gets the struct id from a definition index which must be valid for this environment.

pub fn get_struct(&self, id: StructId) -> StructEnv<'_>

Gets a StructEnv by id.

pub fn get_struct_by_def_idx(&self, idx: StructDefinitionIndex) -> StructEnv<'_>

pub fn into_struct(self, id: StructId) -> StructEnv<'env>

Gets a StructEnv by id, consuming this module env.

pub fn get_struct_count(&self) -> usize

Gets the number of structs in this module.

pub fn get_structs(&'env self) -> impl Iterator<Item = StructEnv<'env>>

Returns iterator over structs in this module.

pub fn into_structs(self) -> impl Iterator<Item = StructEnv<'env>>

Returns iterator over structs in this module.

pub fn globalize_signature(&self, sig: &SignatureToken) -> Type

Globalizes a signature local to this module.

pub fn globalize_signatures(&self, sigs: &[SignatureToken]) -> Vec<Type>

Globalizes a list of signatures.

pub fn get_type_actuals(&self, idx: Option<SignatureIndex>) -> Vec<Type>

Gets a list of type actuals associated with the index in the bytecode.

pub fn get_constant(&self, idx: ConstantPoolIndex) -> &VMConstant

Retrieve a constant from the pool

pub fn get_constant_value(&self, constant: &VMConstant) -> MoveValue

Converts a constant to the specified type. The type must correspond to the expected cannonical representation as defined in move_core_types::values

pub fn self_address(&self) -> &AccountAddress

Return the AccountAdress of this module

pub fn get_address_identifier(&self, idx: AddressIdentifierIndex) -> BigUint

Retrieve an address identifier from the pool

pub fn get_spec_vars(
    &'env self
) -> impl Iterator<Item = (&'env SpecVarId, &'env SpecVarDecl)>

Returns specification variables of this module.

pub fn get_spec_var(&self, id: SpecVarId) -> &SpecVarDecl

Gets spec var by id.

pub fn find_spec_var(&self, name: Symbol) -> Option<&SpecVarDecl>

Find spec var by name.

pub fn get_spec_funs(
    &'env self
) -> impl Iterator<Item = (&'env SpecFunId, &'env SpecFunDecl)>

Returns specification functions of this module.

pub fn get_spec_fun(&self, id: SpecFunId) -> &SpecFunDecl

Gets spec fun by id.

pub fn get_spec(&self) -> &Spec

Gets module specification.

pub fn spec_fun_is_used(&self, spec_fun_id: SpecFunId) -> bool

Returns whether a spec fun is ever called or not.

pub fn get_spec_funs_of_name(
    &self,
    name: Symbol
) -> impl Iterator<Item = (&'env SpecFunId, &'env SpecFunDecl)>

Get all spec fun overloads with the given name.

pub fn disassemble(&self) -> String

Disassemble the module bytecode

pub fn has_specs(&self) -> bool

Return true if the module has any global, module, function, or struct specs

Trait Implementations

impl<'env> Clone for ModuleEnv<'env>

fn clone(&self) -> ModuleEnv<'env>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'env> Debug for ModuleEnv<'env>

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

Formats the value using the given formatter.