Enum NodeState 

pub enum NodeState {
    Initializing,
    Ready,
    Running,
    Recovering {
        reason: String,
        details: Option<Value>,
    },
    Degraded {
        reason: String,
    },
    Failed {
        reason: String,
    },
    Stopped {
        reason: StopReason,
    },
}

Represents the runtime state of a node in the pipeline.

State Machine

Nodes transition through these states during their lifecycle:

    Initializing
         ↓
       Ready ──────────┐
         ↓             │
      Running ←──┐     │
         ↓       │     │
    Recovering ──┘     │
         ↓             │
      Degraded         │
         ↓             │
      Failed ←─────────┘
         ↓
      Stopped

Valid Transitions:

• Initializing → Ready (source nodes) or Running (processing nodes)
• Ready → Running (when pipeline is ready)
• Running → Recovering (temporary issues, will retry)
• Running → Degraded (persistent issues, no retry)
• Running → Failed (fatal error)
• Running → Stopped (graceful shutdown)
• Recovering → Running (recovery succeeded)
• Recovering → Degraded (recovery partially succeeded, quality reduced)
• Recovering → Failed (recovery exhausted, giving up)
• Degraded → Failed (conditions worsened)
• Ready → Failed (initialization timeout or external failure)
• Any state → Stopped (external shutdown request)

Variants

Initializing

Node is starting up and performing initialization. Examples: Opening connections, loading resources, validating configuration.

Ready

Node has completed initialization and is ready to process data. Source nodes (nodes with no inputs) wait in this state until all downstream nodes are also ready, preventing packet loss during pipeline startup. Non-source nodes typically skip this state and go directly to Running.

Running

Node is operating normally and processing data. This is the expected steady state for a healthy node.

Recovering

Node encountered an issue but is actively attempting to recover automatically. The node is still running but may not be processing data during recovery.

Examples:

• Transport node reconnecting after connection loss
• Decoder resyncing after corrupted data
• Node waiting for stalled input to resume

The reason field provides a human-readable explanation. The optional details field can contain node-specific structured information (e.g., retry attempt numbers, affected resources).

Fields

reason: String

details: Option<Value>

Degraded

Node is operational but experiencing persistent issues that affect quality or performance. Unlike Recovering, the node is not actively attempting automatic recovery.

Examples:

• High latency or packet loss in transport
• Resource constraints (CPU, memory pressure)
• Partial functionality (some features unavailable)

The node continues processing but users should be aware of reduced quality.

Fields

reason: String

Failed

Node has encountered a fatal error and stopped processing. Manual intervention is required to restart the node.

Examples:

• Max reconnection attempts exhausted
• Invalid configuration detected at runtime
• Unrecoverable protocol error

Fields

reason: String

Stopped

Node has stopped processing and shut down. The reason field indicates why the node stopped:

• “completed” - Expected end of finite data stream (stateless pipelines)
• “input_closed” - Upstream node closed, no more data to process
• “shutdown” - Graceful shutdown was requested

In live/dynamic pipelines, this state often indicates an issue (unexpected stop). In stateless pipelines, “completed” is the expected end state.

Fields

reason: StopReason

Trait Implementations

impl Clone for NodeState

fn clone(&self) -> NodeState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NodeState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeState

fn deserialize<__D>( __deserializer: __D, ) -> Result<NodeState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NodeState

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for NodeState

type WithoutGenerics = NodeState

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = NodeState

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where NodeState: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where NodeState: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.