Struct PhlowRuntime 

pub struct PhlowRuntime { /* private fields */ }

Prepared runtime that can execute an in-memory pipeline.

Implementations

impl PhlowRuntime

pub fn new() -> Self

Create a new runtime with default settings.

This sets var_main to a default value so non-main pipelines auto-start.

pub fn with_settings(settings: Settings) -> Self

Create a new runtime using explicit settings.

pub fn set_pipeline(&mut self, pipeline: Value) -> &mut Self

Set the pipeline to be executed.

This clears any prepared runtime state.

pub fn set_context(&mut self, context: Context) -> &mut Self

Set the execution context.

This clears any prepared runtime state.

pub fn set_settings(&mut self, settings: Settings) -> &mut Self

Replace the runtime settings.

This clears any prepared runtime state.

pub fn set_base_path<P: Into<PathBuf>>(&mut self, base_path: P) -> &mut Self

Set the base path used for resolving local module paths.

This clears any prepared runtime state.

pub fn set_dispatch(&mut self, dispatch: Dispatch) -> &mut Self

Provide a custom tracing dispatch instead of initializing OpenTelemetry.

This clears any prepared runtime state.

pub fn set_module<S: Into<String>>( &mut self, name: S, module: PhlowModule, ) -> &mut Self

Register an inline module by name.

The module must be declared in the pipeline modules list. The handler runs asynchronously inside the runtime.

This clears any prepared runtime state.

pub fn settings(&self) -> &Settings

Read-only access to the current settings.

pub fn settings_mut(&mut self) -> &mut Settings

Mutable access to settings.

This clears any prepared runtime state.

pub async fn build(&mut self) -> Result<(), PhlowRuntimeError>

Build and prepare the runtime (load modules, tracing, and start loop).

Calling this multiple times is safe; it is a no-op if already prepared.

pub async fn run(&mut self) -> Result<Value, PhlowRuntimeError>

Execute the pipeline and return its result.

This can be called multiple times after build. When the pipeline cannot auto-start (for example, a main module is present and var_main is not set), this returns Value::Undefined and shuts down the prepared runtime. For normal execution, call shutdown when you are done to release resources.

pub async fn shutdown(&mut self) -> Result<(), PhlowRuntimeError>

Shut down the prepared runtime and release resources.

Call this when you are done reusing the runtime to close channels, wait for the runtime task, and flush tracing providers.

Trait Implementations

impl Default for PhlowRuntime

fn default() -> Self

Returns the “default value” for a type.