Struct Value 

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

An SSA value in a function: a block parameter or an instruction result.

Every value has one type and exactly one definition. It prints as v<n>.

Examples

use ir_lang::Value;

let h = Value::from_u32(3);
assert_eq!(h.index(), 3);
assert_eq!(h.to_string(), "v3");

Implementations

impl Value

pub const fn from_u32(index: u32) -> Self

Makes a handle from a raw index.

Handles normally come from the module or function that owns the entity. This constructor exists for side tables and tests; a handle made up this way is checked like any other (an out-of-range handle is a validation error, never a panic).

Examples

use ir_lang::Value;

assert_eq!(Value::from_u32(0).index(), 0);

pub const fn index(self) -> usize

Returns the dense zero-based index of this handle.

Examples

use ir_lang::Value;

assert_eq!(Value::from_u32(7).index(), 7);

pub const fn as_u32(self) -> u32

Returns the raw u32 index.

Examples

use ir_lang::Value;

assert_eq!(Value::from_u32(9).as_u32(), 9);

impl Value

pub const fn next(self) -> Value

The value with the next index. Results of one instruction are consecutive, so first.next() is the second result.

Examples

use ir_lang::Value;

assert_eq!(Value::from_u32(4).next(), Value::from_u32(5));

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Value

impl Debug for Value

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

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl Eq for Value

impl From<Value> for BlockArg

fn from(v: Value) -> Self

Converts to this type from the input type.

impl Hash for Value

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 Value

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for Value