Struct solana_libra_vm::file_format::FunctionDefinition

pub struct FunctionDefinition {
    pub function: FunctionHandleIndex,
    pub flags: u8,
    pub acquires_global_resources: Vec<StructDefinitionIndex>,
    pub code: CodeUnit,
}

A FunctionDefinition is the implementation of a function. It defines the prototype of the function and the function body.

Fields

function: FunctionHandleIndex

The prototype of the function (module, name, signature).

flags: u8

Flags for this function (private, public, native, etc.)

acquires_global_resources: Vec<StructDefinitionIndex>

List of nominal resources (declared in this module) that the procedure might access Either through: BorrowGlobal, MoveFrom, or transitively through another procedure This list of acquires grants the borrow checker the ability to statically verify the safety of references into global storage

Not in the signature as it is not needed outside of the declaring module

Note, there is no LocalsSignatureIndex with each struct definition index, as global resources cannot currently take type arguments

code: CodeUnit

Code for this function.

Methods

impl FunctionDefinition

pub fn is_public(&self) -> bool

Returns whether the FunctionDefinition is public.

pub fn is_native(&self) -> bool

Returns whether the FunctionDefinition is native.

Trait Implementations

impl<'_> BoundsCheck<&'_ CompiledModuleMut> for FunctionDefinition

fn check_bounds(&self, module: &CompiledModuleMut) -> Vec<VMStatus>

impl Clone for FunctionDefinition

fn clone(&self) -> FunctionDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDefinition

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

Formats the value using the given formatter.

impl Default for FunctionDefinition

fn default() -> FunctionDefinition

Returns the "default value" for a type.

impl Eq for FunctionDefinition

impl PartialEq<FunctionDefinition> for FunctionDefinition

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for FunctionDefinition

impl StructuralPartialEq for FunctionDefinition