oxide-update-engine

An engine for declaring and executing sequential update steps with serializable event streams.

The oxide-update-engine crate provides the execution engine for running update steps.

• For types-only consumers (e.g. API clients), see oxide-update-engine-types.
• For code to display update engine events as a human-readable stream, see oxide-update-engine-display.

Examples

A minimal engine that runs a single update step:

use oxide_update_engine::{
    StepSuccess, UpdateEngine, channel,
};
use oxide_update_engine::types::spec::EngineSpec;

// A EngineSpec defines the domain-specific types that flow
// through the engine. Use () for metadata you don't need.
enum MySpec {}
impl EngineSpec for MySpec {
    fn spec_name() -> String {
        "example".into()
    }
    type Component = String;
    type StepId = usize;
    type StepMetadata = ();
    type ProgressMetadata = ();
    type CompletionMetadata = ();
    type SkippedMetadata = ();
    type Error = anyhow::Error;
}

let log =
    slog::Logger::root(slog::Discard, slog::o!());
let (sender, _receiver) = channel::<MySpec>();
let engine = UpdateEngine::new(&log, sender);

// Steps run sequentially in registration order.
engine
    .new_step(
        "fw".to_owned(),
        1,
        "Write firmware image",
        |_cx| async {
            // ... perform update work here ...
            StepSuccess::new(()).into()
        },
    )
    .register();

engine.execute().await?;

For more complex engines, including engines that have nested local and remote steps, see the full example.

License

This project is available under the terms of the Mozilla Public License 2.0.