Struct GlobalValue

pub struct GlobalValue(/* private fields */);

An opaque reference to a global value.

A GlobalValue is a Value that will be live across the entire function lifetime. It can be preloaded from other global values.

You can create a GlobalValue in the following ways:

• When compiling to WASM, you can use it to load values from a VmContext using FuncEnvironment::make_global.
• When compiling to native code, you can use it for objects in static memory with Module::declare_data_in_func.
• For any compilation target, it can be registered with FunctionBuilder::create_global_value.

GlobalValues can be retrieved with InstBuilder:global_value.

While the order is stable, it is arbitrary.

Implementations

impl GlobalValue

pub fn from_u32(x: u32) -> Self

Create a new instance from a u32.

pub fn as_u32(self) -> u32

Return the underlying index value as a u32.

pub fn as_bits(self) -> u32

Return the raw bit encoding for this instance.

pub fn from_bits(x: u32) -> Self

Create a new instance from the raw bit encoding.

impl GlobalValue

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

Create a new global value reference from its number.

This method is for use by the parser.

Trait Implementations

impl Clone for GlobalValue

fn clone(&self) -> GlobalValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalValue

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

Formats the value using the given formatter.

impl Display for GlobalValue

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

Formats the value using the given formatter.

impl EntityRef for GlobalValue

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 From<GlobalValue> for AnyEntity

fn from(r: GlobalValue) -> Self

Converts to this type from the input type.

impl Hash for GlobalValue

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GlobalValue

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GlobalValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GlobalValue

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ReservedValue for GlobalValue

fn reserved_value() -> GlobalValue

Create an instance of the reserved value.

fn is_reserved_value(&self) -> bool

Checks whether value is the reserved one.

impl Copy for GlobalValue

impl Eq for GlobalValue

impl StructuralPartialEq for GlobalValue