Quickstart

Run a typed job locally in Rust or Go without external services.

This quickstart uses headgate’s in-memory test store. You will register a typed handler, enqueue one job, run the real admission and dispatch path, and verify completion.

Rust

cargo run --manifest-path examples/rust/Cargo.toml --bin basic

Expected output:

welcome, Ada
... completed

Build it yourself

1. Define a typed task

   Rust

   #[derive(serde::Serialize, serde::Deserialize, headgate::Task)]
   #[task(kind = "example:welcome", version = 1)]
   struct Welcome { name: String }
   
2. Register its handler

   Rust

   let mut registry = headgate::Registry::new();
   registry.register::<Welcome, _, _>(|_ctx, task| async move {
       println!("welcome, {}", task.name);
       Ok(())
   })?;
   
3. Create and enqueue an envelope

   A durable envelope supplies identity, routing, policy inputs, payload version, and retention. The complete Rust and Go programs are available inside the basic worker example.

4. Drain and verify

   testing::drain and Runner.Drain execute the real admission, dispatch, and fenced ack path.

Use the in-memory store for handler and runtime tests. Use isolated live-store helpers when the behavior depends on SQL, Lua, transactions, migrations, inspection, or notifications.

Next steps

Install a production backend

Learn the job lifecycle

Create resumable work

Run all examples