Crate beetry_engine 

Beetry Engine

This crate is an internal Beetry implementation crate and is not considered part of the public API. For public APIs, use the beetry crate.

TreeEngine is the high-level entry point for loading a tree, preparing the executor, and driving the tree until it reaches a terminal state. It is the most idiomatic way to set up and execute trees.

Engine states

TreeEngine uses the typestate pattern to make the initialization flow explicit and keep required setup steps ordered by construction.

1. TreeEngine in the Configured state: engine created, executor configured
2. TreeEngine in the TreeLoaded state: tree attached by one of the supported methods
3. TreeEngine in the Runnable state: tree ready to be ticked

Structs

Configured

Marker state for an engine that is configured and ready to load a tree.

Runnable

Marker state for an engine whose tree is ready to be ticked.

TreeEngine

Engine for loading and ticking a tree.

TreeEngineConfig

Configuration for constructing a TreeEngine.

TreeLoaded

Marker state for an engine with a loaded tree that has not started running yet.

Enums

Error

Errors that can occur while ticking a tree with the engine.