Struct ExecutorContext 

pub struct ExecutorContext {
    pub engine: Arc<Box<dyn EngineManager>>,
    pub fs: Arc<FileManager>,
    pub settings: ExecutorSettings,
    pub context_type: ContextType,
}

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>

settings: ExecutorSettings

context_type: ContextType

Implementations

impl ExecutorContext

pub async fn open_module( &self, path: &ImportPath, attrs: &[Node<Annotation>], resolved_path: &ModulePath, exec_state: &mut ExecState, source_range: SourceRange, ) -> Result<ModuleId, KclError>

pub async fn exec_module_from_ast( &self, program: &Node<Program>, module_id: ModuleId, path: &ModulePath, exec_state: &mut ExecState, source_range: SourceRange, preserve_mem: bool, ) -> Result<ModuleExecutionOutcome, KclError>

impl ExecutorContext

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

Create a new default executor context.

pub async fn new_mock(settings: Option<ExecutorSettings>) -> Self

pub fn new_forwarded_mock(engine: Arc<Box<dyn EngineManager>>) -> Self

pub async fn new_with_client( settings: ExecutorSettings, token: Option<String>, engine_addr: Option<String>, ) -> Result<Self>

Create a new default executor context. With a kittycad client. This allows for passing in ZOO_API_TOKEN and ZOO_HOST as environment variables. But also allows for passing in a token and engine address directly.

pub async fn new_with_default_client() -> Result<Self>

Create a new default executor context. With the default kittycad client. This allows for passing in ZOO_API_TOKEN and ZOO_HOST as environment variables.

pub async fn new_for_unit_test(engine_addr: Option<String>) -> Result<Self>

For executing unit tests.

pub fn is_mock(&self) -> bool

pub async fn no_engine_commands(&self) -> bool

Returns true if we should not send engine commands for any reason.

pub async fn send_clear_scene( &self, exec_state: &mut ExecState, source_range: SourceRange, ) -> Result<(), KclError>

pub async fn bust_cache_and_reset_scene( &self, ) -> Result<ExecOutcome, KclErrorWithOutputs>

pub async fn run_mock( &self, program: &Program, mock_config: &MockConfig, ) -> Result<ExecOutcome, KclErrorWithOutputs>

pub async fn run_with_caching( &self, program: Program, ) -> Result<ExecOutcome, KclErrorWithOutputs>

pub async fn run( &self, program: &Program, exec_state: &mut ExecState, ) -> Result<(EnvironmentRef, Option<ModelingSessionData>), KclErrorWithOutputs>

Perform the execution of a program.

To access non-fatal errors and warnings, extract them from the ExecState.

pub async fn run_concurrent( &self, program: &Program, exec_state: &mut ExecState, universe_info: Option<(HashMap<String, (Node<ImportStatement>, ModuleId, ModulePath, ModuleRepr)>, HashMap<TypedPath, Node<ImportStatement>>)>, preserve_mem: bool, ) -> Result<(EnvironmentRef, Option<ModelingSessionData>), KclErrorWithOutputs>

Perform the execution of a program using a concurrent execution model.

To access non-fatal errors and warnings, extract them from the ExecState.

pub async fn prepare_snapshot(&self) -> Result<TakeSnapshot, ExecError>

Get a snapshot of the current scene.

pub async fn export( &self, format: OutputFormat3d, ) -> Result<Vec<RawFile>, KclError>

Export the current scene as a CAD file.

pub async fn export_step( &self, deterministic_time: bool, ) -> Result<Vec<RawFile>, KclError>

Export the current scene as a STEP file.

pub async fn close(&self)

Trait Implementations

impl Clone for ExecutorContext

fn clone(&self) -> ExecutorContext

Returns a duplicate 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.