pub struct FunctionDefinition {
    pub function: FunctionHandleIndex,
    pub visibility: Visibility,
    pub acquires_global_resources: Vec<StructDefinitionIndex>,
    pub code: Option<CodeUnit>,
}
Expand description

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.

§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§

source§

impl FunctionDefinition

source

pub fn is_native(&self) -> bool

Returns whether the FunctionDefinition is native.

source

pub const NATIVE: u8 = 2u8

A native function implemented in Rust.

Trait Implementations§

source§

impl Arbitrary for FunctionDefinition

§

type Parameters = usize

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.
§

type Strategy = Map<(<FunctionHandleIndex as Arbitrary>::Strategy, <Visibility as Arbitrary>::Strategy, <Vec<StructDefinitionIndex, Global> as Arbitrary>::Strategy, BoxedStrategy<Option<CodeUnit>>), fn(_: (FunctionHandleIndex, Visibility, Vec<StructDefinitionIndex, Global>, Option<CodeUnit>)) -> FunctionDefinition>

The type of Strategy used to generate values of type Self.
source§

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more
§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
source§

impl Clone for FunctionDefinition

source§

fn clone(&self) -> FunctionDefinition

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for FunctionDefinition

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for FunctionDefinition

source§

fn default() -> FunctionDefinition

Returns the “default value” for a type. Read more
source§

impl PartialEq<FunctionDefinition> for FunctionDefinition

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for FunctionDefinition

source§

impl StructuralEq for FunctionDefinition

source§

impl StructuralPartialEq for FunctionDefinition

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V