Struct SpawnSpec 

#[non_exhaustive]
pub struct SpawnSpec {
    pub blueprint: BlueprintSource,
    pub task: String,
    pub workdir: PathBuf,
    pub model: Option<String>,
    pub regions: HashMap<String, String>,
    pub metadata: HashMap<String, String>,
    pub output: Option<OutputSpec>,
}

One spawn request. Build with SpawnSpec::new, then set the optional fields directly; the struct is non-exhaustive so new options stay additive.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

blueprint: BlueprintSource

The agent’s blueprint.

task: String

The task prompt, seeded into the blueprint’s task region.

workdir: PathBuf

Working directory tools are confined to. Must exist.

model: Option<String>

Optional model override (provider/model or a bare model name).

regions: HashMap<String, String>

Seed content for named caller-input regions.

metadata: HashMap<String, String>

Custom key/value metadata carried in the run’s metadata.

output: Option<OutputSpec>

Ask for the run’s final output in a particular shape, overriding what the blueprint declares.

The format is an opaque label handed to the model, never interpreted here, so an embedder can ask for its own house format without this crate knowing anything about it. Supplying a schema is the one thing that makes the runtime check the answer.

Implementations

impl SpawnSpec

pub fn new( blueprint: BlueprintSource, task: impl Into<String>, workdir: impl Into<PathBuf>, ) -> Self

A spec with the required fields; optional fields start empty.

pub fn output( self, format: impl Into<String>, instructions: Option<String>, ) -> Self

Ask for the final output in format, with optional guidance.

format is carried through untouched: "markdown", "a2ui", a media type, or a shape invented for this program are all equally valid.