Skip to main content

Blueprint

Struct Blueprint 

Source
pub struct Blueprint {
    pub graph_id: String,
    pub start: String,
    pub channels: Vec<ChannelSpec>,
    pub nodes: Vec<NodeSpec>,
    pub edges: Vec<EdgeSpec>,
    pub defaults: Vec<(String, Literal)>,
    pub input: Vec<IoFieldSpec>,
    pub output: Vec<IoFieldSpec>,
    pub checkpoint: Option<String>,
    pub interrupt: Option<String>,
    pub joins: Vec<JoinSpec>,
    pub provenance: Option<BlueprintProvenance>,
}
Expand description

A compiled, semantically validated graph plan.

A Blueprint is the inspectable output of the compiler: it is fully serializable so it can be stored, diffed, reviewed, and reloaded independently of the source text. Runnable node behaviour is not part of the blueprint — it is supplied later by a Rust-side crate::language::compiler::NodeFactory.

Fields§

§graph_id: String

The graph identifier.

§start: String

The validated start node name.

§channels: Vec<ChannelSpec>

State channel specifications.

§nodes: Vec<NodeSpec>

Node specifications.

§edges: Vec<EdgeSpec>

Static edge specifications.

§defaults: Vec<(String, Literal)>

Graph default key/value entries.

§input: Vec<IoFieldSpec>

The declared graph input shape (empty when unspecified).

§output: Vec<IoFieldSpec>

The declared graph output shape (empty when unspecified).

§checkpoint: Option<String>

Graph-level checkpoint policy (inherit, always, …).

§interrupt: Option<String>

Graph-level interrupt policy (manual, auto, …).

§joins: Vec<JoinSpec>

Compiled join/barrier declarations.

§provenance: Option<BlueprintProvenance>

Source provenance: where each piece of this blueprint came from.

Populated by crate::language::compiler::compile_with_provenance (and the crate::language::testkit helpers). The plain compile path leaves this None so its output is unchanged. Surface it through Blueprint::provenance.

Implementations§

Source§

impl Blueprint

Source

pub fn provenance(&self) -> Option<&BlueprintProvenance>

Returns this blueprint’s source provenance, if it was compiled through a provenance-aware path.

Provenance lets a UI, test, or review tool trace every node, channel, and edge back to the exact source span and origin (a file path or a generated plan) it came from.

Trait Implementations§

Source§

impl Clone for Blueprint

Source§

fn clone(&self) -> Blueprint

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Blueprint

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Blueprint

Source§

fn default() -> Blueprint

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Blueprint

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Blueprint

Source§

fn eq(&self, other: &Blueprint) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Blueprint

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Blueprint

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more