Struct move_binary_format::file_format::FunctionDefinition

pub struct FunctionDefinition {
    pub function: FunctionHandleIndex,
    pub visibility: Visibility,
    pub is_entry: bool,
    pub acquires_global_resources: Vec<StructDefinitionIndex>,
    pub code: Option<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).

visibility: Visibility

The visibility of this function.

is_entry: bool

Marker if the function is intended as an entry function. That is

acquires_global_resources: Vec<StructDefinitionIndex>

List of locally defined types (declared in this module) with the Key ability 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 SignatureIndex with each struct definition index, so all instantiations of that type are considered as being acquired

code: Option<CodeUnit>

Code for this function.

Implementations

impl FunctionDefinition

pub fn is_native(&self) -> bool

Returns whether the FunctionDefinition is native.

pub const DEPRECATED_PUBLIC_BIT: u8

pub const NATIVE: u8

A native function implemented in Rust.

pub const ENTRY: u8

An entry function, intended to be used as an entry point to execution

Trait Implementations

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 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 Eq for FunctionDefinition

impl StructuralEq for FunctionDefinition

impl StructuralPartialEq for FunctionDefinition