Struct StreamHandle 

pub struct StreamHandle<S: State> {
    pub stream: Pin<Box<dyn Stream<Item = Result<StreamEvent<S>, JunctureError>> + Send>>,
    /* private fields */
}

Result of a streaming graph execution.

Contains the run identifier for tracking and resumption, alongside the event stream produced by the Pregel engine. Callers use run_id to correlate events with a specific invocation or to resume a stream that was interrupted.

Examples

use juncture_core::{StateGraph, State, StreamMode};
use futures::StreamExt;

let handle = compiled.stream(initial_state, &config, StreamMode::Values).await?;
println!("run_id = {}", handle.run_id());

let mut stream = handle.stream;
while let Some(result) = stream.next().await {
    // process events
}

Fields

stream: Pin<Box<dyn Stream<Item = Result<StreamEvent<S>, JunctureError>> + Send>>

Stream of graph execution events.

Implementations

impl<S: State> StreamHandle<S>

pub fn run_id(&self) -> &str

Returns the unique run identifier for this streaming execution.

pub fn into_parts( self, ) -> (String, Pin<Box<dyn Stream<Item = Result<StreamEvent<S>, JunctureError>> + Send>>)

Consumes the handle, returning the run ID and stream as a tuple.

Trait Implementations

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

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

Formats the value using the given formatter.