Skip to main content

Module engine

Module engine 

Expand description

The embedded engine: one thread per shard, each running a [ShardRuntime] inside a single-threaded Tokio runtime so step functions can use Tokio I/O.

Structs§

Config
Engine
An embedded Fusee engine. Cheap to clone.
EventOptions
The options of a debounced start or batched event.
RunHandle
A run, addressed by workflow ID.
ScheduleHandle
A schedule, addressed by name.
StartOptions
How a run is started.
UpdateOptions
The options of an update.

Enums§

Durability
What survives what. See the documentation’s guarantees page.

Constants§

DEFAULT_PAYLOAD_OFFLOAD_BYTES
Config::payload_offload_bytes of Config::local.
TOOL_RETENTION
The retention a tool opens a data directory with (the CLI’s --dir, fusee backup, fusee export, fusee reshard): nothing expires. Retention is the application’s: a shard removes finished runs past it when it opens, so a tool opening the directory with its own (the 24 h default) would delete runs the application keeps longer.

Functions§

open_directory
open_shared_log
The shared log of a local directory created with log format 3, opened and recovered; None for other directories and modes.
prepare_dir
Creates the data directory if needed and returns its shard count.
read_meta
(shards, log format) of a data directory (None before its first open). Server mode reads it to pick its log.
runtime_config
The runtime settings for one shard of an engine.
write_meta
Writes fusee.meta atomically and durably.

Type Aliases§

EnvFactory
Creates a shard’s storage (server mode and other custom backends).