Struct sway_ir::context::Context

pub struct Context {
    pub modules: Arena<ModuleContent>,
    pub functions: Arena<FunctionContent>,
    pub blocks: Arena<BlockContent>,
    pub values: Arena<ValueContent>,
    pub pointers: Arena<PointerContent>,
    pub aggregates: Arena<AggregateContent>,
    pub abi_instances: Arena<AbiInstanceContent>,
    pub asm_blocks: Arena<AsmBlockContent>,
    /* private fields */
}

The main IR context handle.

Every module, function, block and value is stored here. Some aggregate metadata is also managed by the context.

Fields

modules: Arena<ModuleContent>

functions: Arena<FunctionContent>

blocks: Arena<BlockContent>

values: Arena<ValueContent>

pointers: Arena<PointerContent>

aggregates: Arena<AggregateContent>

abi_instances: Arena<AbiInstanceContent>

asm_blocks: Arena<AsmBlockContent>

Implementations

impl Context

pub fn module_iter(&self) -> ModuleIterator

Return an interator for every module in this context.

pub fn add_aggregate_symbols(
    &mut self,
    aggregate: Aggregate,
    symbols: HashMap<String, u64>
) -> Result<(), String>

Add aggregate (struct) field names and their indicies to the context.

Used to symbolically cross-reference the index to aggregate fields by Context::get_aggregate_index.

pub fn get_aggregate_by_name(&self, name: &str) -> Option<Aggregate>

Return a named aggregate, if known.

pub fn get_aggregate_index(
    &self,
    aggregate: &Aggregate,
    field_name: &str
) -> Option<u64>

Get the field index within an aggregate (struct) by name, if known.

The field names must be registered already using Context::add_aggregate_symbols.

pub fn get_unique_name(&mut self) -> String

Get a globally unique symbol.

The name will be in the form "anon_N", where N is an incrementing decimal.

impl Context

pub fn verify(&self) -> Result<(), String>

Verify the contents of this Context is valid.

Trait Implementations

impl Default for Context

fn default() -> Context

Returns the “default value” for a type.

impl Display for Context

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

Formats the value using the given formatter.

impl From<Context> for String

fn from(context: Context) -> Self

Performs the conversion.