Struct heartfelt::runtime::Runtime

pub struct Runtime { /* fields omitted */ }

A runtime executing heartfelt programs

This runtime unsafely implements Sync and Send. While thread safety is not given for the runtime from the rust perspective it is still sound from the heartfelt domain. The only way to break thread safety is to use the immutably borrowing def and set var functions from multiple threads or to use the run_unsafe function. The second one is allowed to break thread safety because it is marked as unsafe. The first reason should probably be marked as unsafe too as it violates rusts thread safety rules, but as the runtime is the bridge between Rust and Heartfelt it is ok to not mark it as unsafe as it is still sound from the heartfelt perspective

Implementations

impl Runtime

API Functions

pub fn new() -> Self

pub fn run(&mut self) -> Data

pub unsafe fn run_unsafe(&self) -> Data

pub fn set_program(&mut self, program: Program)

pub fn add_instructions(&mut self, instructions: Program)

pub fn add_instruction(&mut self, instructions: InstructionCall)

pub fn prepend_instructions(&mut self, instructions: Program)

pub fn prepend_instruction(&mut self, instruction: InstructionCall)

pub fn clear_program(&mut self)

pub fn clear(&mut self)

pub fn reset_program(&mut self)

pub fn reset(&mut self)

pub fn take_program(&mut self) -> Program

pub fn swap_program(&mut self, new_program: &mut Program)

pub fn def_var(&self, key: String, value: Data) -> Option<Data>

Returns the previous value associated with key

pub fn set_var(&self, key: &str, value: Data) -> bool

Returns true if value existed false otherwise

pub fn get_var_ref(&self, key: &str) -> Option<&Data>

pub unsafe fn get_var_mut_unsafe(&self, key: &str) -> Option<&mut Data>

pub fn get_var_mut(&mut self, key: &str) -> Option<&mut Data>

pub fn get_var(&self, key: &str) -> Option<Data>

pub fn is_var_defined(&self, key: &str) -> bool

pub fn goto(&self, instruction_idx: usize)

pub fn goto_label(&self, label: &str) -> bool

pub fn add_label(&mut self, label: String, instruction_idx: usize)

pub fn set_labels(&mut self, labels: Labels)

pub fn program_len(&self) -> usize

pub fn program_line_count(&self) -> usize

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

pub fn dump_to(&self, w: &mut impl Write) -> Result<(), IoError>

pub fn fmt_to(&self, w: &mut impl Write) -> FmtResult

Trait Implementations

impl Default for Runtime

pub fn default() -> Runtime

Returns the "default value" for a type.

impl Send for Runtime

impl Sync for Runtime