Enum bytecode::access_path::Root

pub enum Root {
    Global(GlobalKey),
    Formal(TempIndex),
    Local(TempIndex),
    Return(usize),
}

Root of an access path: a global, local, or return variable

Variants

Global(GlobalKey)

A key in global storage

Formal(TempIndex)

A formal parameter

Local(TempIndex)

A local variable

Return(usize)

A return variable

Implementations

impl Root

pub fn from_index(index: TempIndex, fun: &FunctionEnv<'_>) -> Self

Create a Root from local index index

pub fn global(key: GlobalKey) -> Self

Create a Root from global storage key key

pub fn ret(index: usize) -> Self

Create a Root from return variable index

pub fn get_type(&self, fun: &FunctionEnv<'_>) -> Type

Return the type of self in fun

pub fn is_formal(&self) -> bool

Return true if this variable is a formal parameter

pub fn is_return(&self) -> bool

Return true if this variable is a return value

pub fn is_local(&self) -> bool

Return true if this variable is a lol

pub fn is_statically_known(&self) -> bool

Return true if self can be determined statically

pub fn substitute_footprint( &mut self, actuals: &[TempIndex], type_actuals: &[Type], func_env: &FunctionEnv<'_>, sub_map: &dyn AccessPathMap<AbsAddr> )

Replace all footprint paths in self using actuals and sub_map. Bind free type variables to type_actuals.

pub fn display<'a>(&'a self, env: &'a FunctionEnv<'_>) -> RootDisplay<'a>

Return a wrapper of self that implements Display using env

Trait Implementations

impl Clone for Root

fn clone(&self) -> Root

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Root

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

Formats the value using the given formatter.

impl Ord for Root

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Root> for Root

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

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

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.

impl PartialOrd<Root> for Root

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

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

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

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

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

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

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

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

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 Eq for Root

impl StructuralEq for Root

impl StructuralPartialEq for Root