Struct EngineManager 

pub struct EngineManager { /* private fields */ }

Implementations

impl EngineManager

pub fn builder() -> EngineManagerBuilder

Create an instance of EngineManager using the builder syntax

impl EngineManager

pub async fn new_websocket_transport( ws: Upgraded, heartbeats: Option<u64>, ) -> Self

pub fn new_mock() -> Self

Mock connection that doesn’t actually connect to anything. Used for testing.

pub async fn take_responses(&self) -> IndexMap<Uuid, WebSocketResponse>

Take the responses that have accumulated so far and clear them.

pub async fn clear_scene( &self, batch_context: &EngineBatchContext, id_generator: &mut IdGenerator, source_range: SourceRange, ) -> Result<(), KclError>

pub async fn ensure_async_command_completed( &self, id: Uuid, source_range: Option<SourceRange>, ) -> Result<OkWebSocketResponseData, KclError>

Ensure a specific async command has been completed.

pub async fn ensure_async_commands_completed( &self, batch_context: &EngineBatchContext, ) -> Result<(), KclError>

Ensure ALL async commands have been completed.

pub async fn reapply_settings( &self, batch_context: &EngineBatchContext, settings: &ExecutorSettings, source_range: SourceRange, id_generator: &mut IdGenerator, grid_scale_unit: GridScaleBehavior, ) -> Result<(), KclError>

Re-run the command to apply the settings.

pub async fn batch_modeling_cmd( &self, batch_context: &EngineBatchContext, id: Uuid, source_range: SourceRange, cmd: &ModelingCmd, ) -> Result<(), KclError>

pub async fn batch_modeling_cmds( &self, batch_context: &EngineBatchContext, source_range: SourceRange, cmds: &[ModelingCmdReq], ) -> Result<(), KclError>

pub async fn batch_end_cmd( &self, batch_context: &EngineBatchContext, id: Uuid, source_range: SourceRange, cmd: &ModelingCmd, ) -> Result<(), KclError>

Add a command to the batch that needs to be executed at the very end. This for stuff like fillets or chamfers where if we execute too soon the engine will eat the ID and we can’t reference it for other commands.

pub async fn send_modeling_cmd( &self, batch_context: &EngineBatchContext, id: Uuid, source_range: SourceRange, cmd: &ModelingCmd, ) -> Result<OkWebSocketResponseData, KclError>

Send the modeling cmd and wait for the response.

pub async fn async_modeling_cmd( &self, id: Uuid, source_range: SourceRange, cmd: &ModelingCmd, ) -> Result<(), KclError>

Send the modeling cmd async and don’t wait for the response. Add it to our list of async commands.

pub async fn flush_batch( &self, batch_context: &EngineBatchContext, batch_end: bool, source_range: SourceRange, ) -> Result<OkWebSocketResponseData, KclError>

Force flush the batch queue.

pub async fn clear_queues(&self, batch_context: &EngineBatchContext)

pub fn stats(&self) -> &EngineStats

pub fn get_default_planes(&self) -> Arc<RwLock<Option<DefaultPlanes>>>

pub async fn get_session_data(&self) -> Option<ModelingSessionData>

pub async fn close(&self)

Trait Implementations

impl Debug for EngineManager

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

Formats the value using the given formatter.