Struct CompiledGraph 

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

The compiled, executable graph.

Implementations

impl<S: State> CompiledGraph<S>

pub fn with_checkpointer(self, checkpointer: Arc<dyn Checkpointer>) -> Self

Set a checkpointer for state persistence.

pub fn context(&self) -> &GraphContext

Get the GraphContext for this compiled graph.

Nodes can use this context to issue dynamic control flow commands (e.g., goto or end) that override normal edge-based routing.

pub async fn invoke(&self, state: S) -> Result<S, SynapseError>

where S: Serialize + DeserializeOwned,

Execute the graph with initial state.

pub async fn invoke_with_config( &self, state: S, config: Option<CheckpointConfig>, ) -> Result<S, SynapseError>

where S: Serialize + DeserializeOwned,

Execute with optional checkpoint config for resumption.

pub fn stream(&self, state: S, mode: StreamMode) -> GraphStream<'_, S>

where S: Serialize + DeserializeOwned + Clone,

Stream graph execution, yielding a GraphEvent after each node.

pub fn stream_with_config( &self, state: S, _mode: StreamMode, config: Option<CheckpointConfig>, ) -> GraphStream<'_, S>

where S: Serialize + DeserializeOwned + Clone,

Stream graph execution with optional checkpoint config.

pub async fn update_state( &self, config: &CheckpointConfig, update: S, ) -> Result<(), SynapseError>

where S: Serialize + DeserializeOwned,

Update state on an interrupted graph (for human-in-the-loop).

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

where S: DeserializeOwned,

Get the current state for a thread from the checkpointer.

Returns None if no checkpoint exists for the given thread.

pub async fn get_state_history( &self, config: &CheckpointConfig, ) -> Result<Vec<(S, Option<String>)>, SynapseError>

where S: DeserializeOwned,

Get the state history for a thread (all checkpoints).

Returns a list of (state, next_node) pairs, ordered from oldest to newest. The next_node indicates which node was scheduled to execute next when the checkpoint was saved.

impl<S: State> CompiledGraph<S>

pub fn draw_mermaid(&self) -> String

Render the graph as a Mermaid flowchart string.

• __start__ and __end__ are rendered as rounded nodes ([...])
• User nodes are rendered as rectangles [...]
• Fixed edges use solid arrows -->
• Conditional edges with path_map use dashed arrows -.-> with labels
• Conditional edges without path_map emit a Mermaid comment

pub fn draw_ascii(&self) -> String

Render the graph as a simple ASCII text summary.

pub fn draw_dot(&self) -> String

Render the graph in Graphviz DOT format.

pub async fn draw_mermaid_png( &self, path: impl AsRef<Path>, ) -> Result<(), SynapseError>

Render the Mermaid diagram as an image via the mermaid.ink API.

Requires internet access. The generated Mermaid text is URL-safe base64-encoded and sent to https://mermaid.ink/img/{encoded}. The image (JPEG format) is written to the specified file path.

Note: mermaid.ink returns JPEG from the /img/ endpoint. For SVG output, use draw_mermaid_svg instead.

pub async fn draw_mermaid_svg( &self, path: impl AsRef<Path>, ) -> Result<(), SynapseError>

Render the Mermaid diagram as an SVG image via the mermaid.ink API.

Requires internet access. The generated Mermaid text is URL-safe base64-encoded and sent to https://mermaid.ink/svg/{encoded}. The SVG response is written to the specified file path.

pub fn draw_png(&self, path: impl AsRef<Path>) -> Result<(), SynapseError>

Render the graph as a PNG image using the Graphviz dot command.

Requires dot (Graphviz) to be installed and available in $PATH. The DOT output is piped to dot -Tpng and the resulting PNG is written to the specified file path.

Trait Implementations

impl<S: State> Debug for CompiledGraph<S>

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

Formats the value using the given formatter.

impl<S: State> Display for CompiledGraph<S>

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

Formats the value using the given formatter.