Skip to main content

StateGraph

Struct StateGraph 

Source
pub struct StateGraph<S: State> { /* private fields */ }
Expand description

Declarative graph definition with typed nodes and edges.

Build a graph using the fluent API, then call compile() to validate and freeze it into a CompiledGraph for execution.

§Example

use pe_graph::{StateGraph, START, END};

let graph = StateGraph::new()
    .add_node("prepare", prepare_node)
    .add_node("chat", chat_node)
    .add_edge(START, "prepare")
    .add_edge("prepare", "chat")
    .add_edge("chat", END)
    .compile()?;

Implementations§

Source§

impl<S: State> StateGraph<S>

Source

pub fn new() -> Self

Create an empty graph definition.

Source

pub fn add_node( self, name: impl Into<String>, node: impl NodeFn<S> + 'static, ) -> Self

Add a named node to the graph.

Reserved names (START, END) are rejected at compile() time, not here — so the builder stays infallible and chainable.

Source

pub fn add_edge(self, from: impl Into<String>, to: impl Into<String>) -> Self

Add a fixed edge: from always transitions to to after completing.

Use START for the first node, END for terminal nodes.

Source

pub fn add_conditional_edge( self, from: impl Into<String>, router: impl Fn(&S) -> Vec<String> + Send + Sync + 'static, ) -> Self

Add a conditional edge: router reads state and returns next node names.

Return vec![END.to_string()] to terminate. Return multiple names for parallel execution in the next superstep.

Source

pub fn compile(self) -> Result<CompiledGraph<S>, PeError>

Validate the graph structure and freeze it into a CompiledGraph.

Validation checks:

  • START has at least one outgoing edge
  • All fixed edge targets/sources exist as node names (or START/END)
  • No conditional edges from START
  • All nodes are reachable from START

Trait Implementations§

Source§

impl<S: State> Default for StateGraph<S>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for StateGraph<S>

§

impl<S> !UnwindSafe for StateGraph<S>

§

impl<S> Freeze for StateGraph<S>

§

impl<S> Send for StateGraph<S>

§

impl<S> Sync for StateGraph<S>

§

impl<S> Unpin for StateGraph<S>

§

impl<S> UnsafeUnpin for StateGraph<S>

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> 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, 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