Struct GlobalItemIndex 

pub struct GlobalItemIndex {
    pub module: ModuleIndex,
    pub index: ItemIndex,
}

Uniquely identifies an item in a set of crate::ast::Module

A GlobalItemIndex is assigned to an item when it is added to the linker’s module graph. The index uniquely identifies that item in the graph, and provides a unique, copyable, machine-word sized handle that can be trivially stored, passed around, and later used to perform constant-complexity operations against that item.

As a result of this being just an index into a specific instance of a [super::ModuleGraph], it does not provide any guarantees about uniqueness or stability when the same module is stored in multiple graphs - each graph may assign it a unique index. You must ensure that you do not store these indices and attempt to use them with just any module graph - it is only valid with the one it was assigned from.

In addition to the linker’s module graph, these indices are also used with an instance of a MastForestBuilder. This is because the linker and MastForestBuilder instances are paired, i.e. the linker stores the syntax trees and call graph analysis for a program, while the MastForestBuilder caches the compiled procedures for the same program, as derived from the corresponding graph.

This is intended for use when we are doing global inter-procedural analysis on a (possibly growable) set of modules. It is expected that the index of a module in the set, as well as the index of an item in a module, are stable once allocated in the graph. The set of modules and items can grow, as long as growing the set only allocates unused identifiers.

NOTE: This struct is the same size as a u32

Fields

module: ModuleIndex

The index of the containing module in the global set of modules

index: ItemIndex

The local index of the procedure in the module

Trait Implementations

impl Clone for GlobalItemIndex

fn clone(&self) -> GlobalItemIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalItemIndex

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

Formats the value using the given formatter.

impl Display for GlobalItemIndex

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

Formats the value using the given formatter.

impl Hash for GlobalItemIndex

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 GlobalItemIndex

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

fn eq(&self, other: &GlobalItemIndex) -> 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 GlobalItemIndex

fn partial_cmp(&self, other: &GlobalItemIndex) -> 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 Copy for GlobalItemIndex

impl Eq for GlobalItemIndex

impl StructuralPartialEq for GlobalItemIndex