Struct cranelift_codegen::ir::entities::FuncRef

pub struct FuncRef(_);

An opaque reference to another Function.

FuncRefs are used for direct function calls and by func_addr for use in indirect function calls.

FuncRefs can be created with

• FunctionBuilder::import_function for external functions
• Module::declare_func_in_func for functions declared elsewhere in the same native Module
• FuncEnvironment::make_direct_func for functions declared in the same WebAssembly FuncEnvironment

While the order is stable, it is arbitrary.

Methods

impl FuncRef

pub fn from_u32(x: u32) -> Self

Return the underlying index value as a u32.

pub fn as_u32(self) -> u32

Return the underlying index value as a u32.

impl FuncRef

pub fn with_number(n: u32) -> Option<Self>

Create a new external function reference from its number.

This method is for use by the parser.

Trait Implementations

impl Clone for FuncRef

fn clone(&self) -> FuncRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FuncRef

impl Debug for FuncRef

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

Formats the value using the given formatter.

impl Display for FuncRef

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

Formats the value using the given formatter.

impl EntityRef for FuncRef

fn new(index: usize) -> Self

Create a new entity reference from a small integer. This should crash if the requested index is not representable.

fn index(self) -> usize

Get the index that was used to create this entity reference.

impl Eq for FuncRef

impl From<FuncRef> for AnyEntity

fn from(r: FuncRef) -> Self

Performs the conversion.

impl Hash for FuncRef

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for FuncRef

fn cmp(&self, other: &FuncRef) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FuncRef> for FuncRef

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

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

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

This method tests for !=.

impl PartialOrd<FuncRef> for FuncRef

fn partial_cmp(&self, other: &FuncRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &FuncRef) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &FuncRef) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &FuncRef) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &FuncRef) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ReservedValue for FuncRef

fn reserved_value() -> FuncRef

Create an instance of the reserved value.

impl StructuralEq for FuncRef

impl StructuralPartialEq for FuncRef