Struct kcl_lib::executor::ExecutorContext

pub struct ExecutorContext {
    pub engine: Arc<Box<dyn EngineManager>>,
    pub fs: Arc<FileManager>,
    pub stdlib: Arc<StdLib>,
    pub settings: ExecutorSettings,
    pub is_mock: bool,
}

The executor context. Cloning will return another handle to the same engine connection/session, as this uses Arc under the hood.

Fields

engine: Arc<Box<dyn EngineManager>>

fs: Arc<FileManager>

stdlib: Arc<StdLib>

settings: ExecutorSettings

is_mock: bool

Mock mode is only for the modeling app when they just want to mock engine calls and not actually make them.

Implementations

impl ExecutorContext

pub async fn new(client: &Client, settings: ExecutorSettings) -> Result<Self>

Create a new default executor context.

pub async fn new_for_unit_test(units: UnitLength) -> Result<Self>

For executing unit tests.

pub async fn reset_scene(&self) -> Result<()>

Clear everything in the scene.

pub async fn run( &self, program: &Program, memory: Option<ProgramMemory>, ) -> Result<ProgramMemory, KclError>

Perform the execution of a program. You can optionally pass in some initialization memory. Kurt uses this for partial execution.

pub async fn arg_into_mem_item<'a>( &self, init: &Value, memory: &mut ProgramMemory, pipe_info: &PipeInfo, metadata: &Metadata, statement_kind: StatementKind<'a>, ) -> Result<MemoryItem, KclError>

pub fn update_units(&mut self, units: UnitLength)

Update the units for the executor.

pub async fn execute_and_prepare_snapshot( &self, program: &Program, ) -> Result<TakeSnapshot>

Execute the program, then get a PNG screenshot.

Trait Implementations

impl Clone for ExecutorContext

fn clone(&self) -> ExecutorContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutorContext

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

Formats the value using the given formatter.