Skip to main content

StateSpec

Struct StateSpec 

Source
pub struct StateSpec { /* private fields */ }
Expand description

The graph’s state schema: channel name → Reducer.

The spec serves two roles:

  1. Merge semantics: at each super-step barrier, node updates are merged into the shared state via the channel’s reducer (StateSpec::apply_super_step).
  2. Write validation (LastValue rule): within one super-step, a single-write channel may receive at most one write across all nodes that ran in parallel. A second write yields RustyError::InvalidUpdate, mirroring LangGraph’s InvalidUpdateError: Can receive only one value per step.

Writes to channels not declared in the spec are also rejected with RustyError::InvalidUpdate; the spec is the complete schema.

Implementations§

Source§

impl StateSpec

Source

pub fn new() -> Self

An empty spec (no channels declared).

Source

pub fn channel(self, name: impl Into<String>, reducer: Reducer) -> Self

Builder-style: declare a channel with the given reducer.

Source

pub fn add_channel( &mut self, name: impl Into<String>, reducer: Reducer, ) -> &mut Self

Mutable variant of StateSpec::channel.

Source

pub fn reducer_for(&self, channel: &str) -> Reducer

The reducer for a channel, defaulting to Reducer::Overwrite (LastValue semantics) for undeclared channels.

The default is a convenience for contexts where the channel is known to be declared. When the channel may be undeclared, use StateSpec::try_reducer_for and handle None — silently treating an undeclared channel as Overwrite is almost never the intent. StateSpec::apply_super_step always validates channels first, so the default is unreachable on that path.

Source

pub fn try_reducer_for(&self, channel: &str) -> Option<Reducer>

The reducer for a channel, or None if the channel is not declared.

Source

pub fn channel_names(&self) -> impl Iterator<Item = &str>

All declared channel names.

Source

pub fn has_channel(&self, channel: &str) -> bool

true if the channel is declared in this spec.

Source

pub fn apply_super_step<I, S>(&self, state: &mut State, writes: I) -> Result<()>
where I: IntoIterator<Item = (S, HashMap<String, Value>)>, S: AsRef<str>,

Validate and merge all writes of one super-step into state.

writes is the collection of (node_name, updates) pairs produced by the nodes that ran in this super-step. Each entry is one node’s partial update map (channel -> value), as carried by crate::node::NodeOutput::updates.

Semantics, in order:

  1. Every written channel must be declared in this spec (RustyError::InvalidUpdate otherwise).
  2. A channel whose reducer does not allow multiple writes (i.e. Reducer::Overwrite) may appear in at most one node’s updates per super-step; a second write is RustyError::InvalidUpdate.
  3. For Reducer::Append and Reducer::AddMessages channels, the current state value (if present) must be an array; a non-array current value indicates a type bug in the graph spec and is rejected with RustyError::InvalidUpdate rather than silently discarded.
  4. Surviving writes are merged via the channel reducer in deterministic order: sorted by node name. The executor collects writes from concurrently completing tasks, so callers cannot rely on input order; canonicalizing here keeps fan-in results (and checkpoints derived from them) stable run-to-run.

Validation completes before any mutation: on error the state is left entirely unmodified and the caller (executor) should abort the super-step — LangGraph treats a super-step as transactional.

Source

pub fn apply_single( &self, state: &mut State, node: &str, updates: HashMap<String, Value>, ) -> Result<()>

Convenience: merge a single node’s updates (e.g. outside the parallel super-step path). Single-write validation trivially passes since only one writer is involved.

Trait Implementations§

Source§

impl Clone for StateSpec

Source§

fn clone(&self) -> Self

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 StateSpec

Source§

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

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

impl Default for StateSpec

Source§

fn default() -> Self

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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