Struct CldbRun

pub struct CldbRun { /* private fields */ }

CldbRun is the main object used to run KLVM code in a stepwise way. The main advantage of CldbRun over klvmr’s runner is that the caller observes a new step being returned after it asks for each step to be run. The progress of evaulation is observable and hopefully understandable and in an order which, combined with observing the RunStep can help with debugging.

CldmbRun contains a RunStep and moves evaluation forward every time its step method is called, along with having some convenience methods, like being able to ask whether the run ended and what the final result was (if it completed).

The result is a map of key value pairs indicating various information about the run.

Implementations

impl CldbRun

pub fn new( runner: Rc<dyn TRunProgram>, prim_map: Rc<HashMap<Vec<u8>, Rc<SExp>>>, env: Box<dyn CldbEnvironment>, step: RunStep, ) -> Self

Create a new CldbRun for running a program. Takes an CldbEnvironment and a prepared RunStep, which will be stepped through. The CldbEnvironment specifies places where the consumer has the ability to examine the run step and possibly alter the result of execution.

pub fn set_flags(&mut self, flags: u32)

pub fn set_print_only(&mut self, pronly: bool)

pub fn is_ended(&self) -> bool

pub fn final_result(&self) -> Option<Rc<SExp>>

pub fn should_print_basic_output(&self) -> bool

pub fn step( &mut self, allocator: &mut Allocator, ) -> Option<BTreeMap<String, String>>

pub fn current_step(&self) -> RunStep