Skip to main content

CompiledGraph

Struct CompiledGraph 

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

A compiled, executable graph.

CompiledGraph is the result of compiling a StateGraph. It provides methods to execute the graph with different invocation patterns.

Implementations§

Source§

impl<S: State> CompiledGraph<S>

Source

pub async fn invoke(&mut self, input: S, config: Config) -> Result<S>

Execute the graph with the given input

This runs the graph to completion and returns the final state.

§Arguments
  • input - Initial state
  • config - Execution configuration
§Returns

The final state after graph execution

§Example
let app = graph.compile(None)?;

let result = app.invoke(
    MyState { count: 0 },
    Config::default()
).await?;

println!("Final count: {}", result.count);
Source

pub async fn stream( &mut self, input: S, config: Config, mode: StreamMode, ) -> Result<Pin<Box<dyn Stream<Item = Result<StreamEvent>> + Send>>>

Stream execution events

Returns a stream of events as the graph executes, allowing real-time observation of progress.

§Arguments
  • input - Initial state
  • config - Execution configuration
  • mode - Type of events to stream
Source

pub async fn get_state( &self, config: &Config, ) -> Result<Option<StateSnapshot<S>>>

Get the current state for a given configuration

This retrieves the most recent checkpoint for the thread.

Source

pub async fn get_state_history( &self, config: &Config, limit: Option<usize>, ) -> Result<Vec<StateSnapshot<S>>>

Get the state history for a thread

Returns past checkpoints in reverse chronological order.

Source

pub async fn update_state( &mut self, config: Config, values: S, ) -> Result<Config>

Update the state for a thread

This allows modifying the checkpoint state, useful for human-in-the-loop patterns.

Auto Trait Implementations§

§

impl<S> Freeze for CompiledGraph<S>

§

impl<S> !RefUnwindSafe for CompiledGraph<S>

§

impl<S> Send for CompiledGraph<S>

§

impl<S> Sync for CompiledGraph<S>

§

impl<S> Unpin for CompiledGraph<S>

§

impl<S> UnsafeUnpin for CompiledGraph<S>

§

impl<S> !UnwindSafe for CompiledGraph<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, 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.