Struct cranelift_codegen::ir::entities::Heap

pub struct Heap(_);

An opaque reference to a heap.

Heaps are used to access dynamically allocated memory through heap_addr.

To create a heap, use FunctionBuilder::create_heap.

While the order is stable, it is arbitrary.

Implementations

impl Heap

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.

impl Heap

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

Create a new heap reference from its number.

This method is for use by the parser.

Trait Implementations

impl Clone for Heap

fn clone(&self) -> Heap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Heap

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

Formats the value using the given formatter.

impl Display for Heap

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

Formats the value using the given formatter.

impl EntityRef for Heap

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<Heap> for AnyEntity

fn from(r: Heap) -> Self

Performs the conversion.

impl Hash for Heap

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub 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 Heap

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Heap> for Heap

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

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

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

This method tests for !=.

impl PartialOrd<Heap> for Heap

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl ReservedValue for Heap

fn reserved_value() -> Heap

Create an instance of the reserved value.

fn is_reserved_value(&self) -> bool

Checks whether value is the reserved one.

impl Copy for Heap

impl Eq for Heap

impl StructuralEq for Heap

impl StructuralPartialEq for Heap