Struct runestick::unit::Unit

pub struct Unit { /* fields omitted */ }

Instructions from a single source file.

Implementations

impl Unit

pub fn new() -> Self

Construct a new unit.

pub fn with_default_prelude() -> Self

Construct a new unit with the default prelude.

pub fn contains_name(&self, item: &Item) -> bool

Check if unit contains the given name.

pub fn contains_prefix(&self, item: &Item) -> bool

Check if unit contains the given name by prefix.

pub fn iter_components<I>(&self, iter: I) -> impl Iterator<Item = &Component> where
    I: IntoIterator,
    I::Item: Into<Component>, 

Iterate over known child components of the given name.

pub fn lookup_meta(&self, name: &Item) -> Option<Meta>

Access the meta for the given language item.

pub fn lookup_type(&self, hash: Hash) -> Option<&UnitTypeInfo>

Access the type for the given language item.

pub fn function_at(&self, n: usize) -> Option<(Hash, &UnitFnInfo)>

Access the function at the given instruction location.

pub fn debug_info(&self) -> Option<&DebugInfo>

Access debug information for the given location if it is available.

pub fn debug_info_mut(&mut self) -> &mut DebugInfo

Insert and access a builder for debug information.

pub fn instruction_at(&self, ip: usize) -> Option<&Inst>

Get the instruction at the given instruction pointer.

pub fn iter_static_strings(
    &self
) -> impl Iterator<Item = &Arc<StaticString>> + '_

Iterate over all static strings in the unit.

pub fn iter_static_object_keys(
    &self
) -> impl Iterator<Item = (Hash, &[String])> + '_

Iterate over all static object keys in the unit.

pub fn iter_instructions(&self) -> impl Iterator<Item = Inst> + '_

Iterate over all instructions in order.

pub fn iter_functions(
    &self
) -> impl Iterator<Item = (Hash, &Arc<UnitFnInfo>)> + '_

Iterate over known functions.

pub fn iter_imports<'a>(
    &'a self
) -> impl Iterator<Item = (&'a ImportKey, &'a ImportEntry)> + '_

Iterate over known imports.

pub fn lookup_string(&self, slot: usize) -> Result<&Arc<StaticString>, VmError>

Lookup the static string by slot, if it exists.

pub fn lookup_bytes(&self, slot: usize) -> Result<&[u8], VmError>

Lookup the static byte string by slot, if it exists.

pub fn lookup_object_keys(&self, slot: usize) -> Option<&[String]>

Lookup the static object keys by slot, if it exists.

pub fn new_static_string(&mut self, current: &str) -> Result<usize, UnitError>

Insert a static string and return its associated slot that can later be looked up through lookup_string.

Only uses up space if the static string is unique.

pub fn new_static_bytes(&mut self, current: &[u8]) -> Result<usize, UnitError>

Insert a static byte string and return its associated slot that can later be looked up through lookup_bytes.

Only uses up space if the static byte string is unique.

pub fn new_static_object_keys(
    &mut self,
    current: &[String]
) -> Result<usize, UnitError>

Insert a new collection of static object keys, or return one already existing.

pub fn lookup(&self, hash: Hash) -> Option<&Arc<UnitFnInfo>>

Lookup information of a function.

pub fn lookup_import(&self, key: &ImportKey) -> Option<&ImportEntry>

Look up an use by name.

pub fn new_import<I>(
    &mut self,
    item: Item,
    path: I,
    span: Span
) -> Result<(), UnitError> where
    I: Copy + IntoIterator,
    I::Item: Into<Component>, 

Declare a new import.

pub fn insert_meta(&mut self, meta: Meta) -> Result<(), UnitError>

Declare a new struct.

pub fn new_assembly(&self) -> Assembly

Construct a new empty assembly associated with the current unit.

pub fn new_function(
    &mut self,
    source_id: usize,
    path: Item,
    args: usize,
    assembly: Assembly,
    call: Call
) -> Result<(), UnitError>

Declare a new function at the current instruction pointer.

pub fn new_instance_function(
    &mut self,
    source_id: usize,
    path: Item,
    value_type: ValueType,
    name: &str,
    args: usize,
    assembly: Assembly,
    call: Call
) -> Result<(), UnitError>

Declare a new instance function at the current instruction pointer.

pub fn link(&self, context: &Context, errors: &mut LinkerErrors) -> bool

Try to link the unit with the context, checking that all necessary functions are provided.

This can prevent a number of runtime errors, like missing functions.

Trait Implementations

impl Debug for Unit

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

Formats the value using the given formatter.

impl Default for Unit

fn default() -> Unit

Returns the "default value" for a type.