Adding `wavelet` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add wavelet

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

wavelet = "0.6.1"

The wavelet library will be automatically available globally. Read the wavelet library documentation.

Back to the crate overview.

Readme

Wavelet

A high-performance, graph-based stream processing runtime for Rust.

Wavelet

Overview

Wavelet is designed for applications that need predictable, low-latency stream processing without the overhead of async runtimes or actor systems. Built around a computation graph where nodes represent stream processors and edges define data dependencies, wavelet provides:

Deterministic execution - Same inputs always produce the same execution order
Dependency-ordered processing - Guaranteed that parent nodes are always processed before their children
Event integration - Unified I/O, timer, and yield event handling
Dependency injection - Build-time configuration for different environments

Quick Start

Add wavelet to your Cargo.toml:

[dependencies]
wavelet = "0.1"

Create a simple stream processing graph:

use wavelet::prelude::*;
use std::time::Duration;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let runtime = RealtimeRuntime::new(ExecutionMode::Park);

    // Create a data source
    let source = NodeBuilder::new(0u64)
        .on_init(|executor, _, idx| {
            executor.yield_driver().yield_now(idx);
        })
        .build(runtime.executor(), |counter, _ctx| {
            *counter += 1;
            println!("Source: {}", counter);
            Control::Broadcast
        });

    // Create a processor that reacts to the source
    let _processor = NodeBuilder::new(String::new())
        .triggered_by(&source)
        .build(runtime.executor(), |state, _ctx| {
            *state = format!("Processed: {}", source.borrow());
            println!("{}", state);
            Control::Unchanged
        });

    // Run the graph
    runtime.run_forever();
}

Architecture

Relationships: Define how nodes interact in the computation graph. Trigger relationships cause immediate downstream execution when a node broadcasts changes, while Observe relationships create dependencies without automatic propagation, allowing nodes to inspect upstream state on-demand.

Core Concepts

Node: A computational unit that processes data from upstream nodes and optionally propagates results downstream. Nodes can perform transformations, aggregations, filtering, side effects, or any custom business logic.

Cooperative Scheduling: Multi-depth scheduling system that processes nodes in dependency order. Nodes execute atomically and return control to the scheduler, which ensures proper execution sequencing and prevents infinite loops through epoch-based deduplication.

Event System: External event integration that drives graph execution. I/O events (network, file operations), timer events (scheduled execution), and yield events (immediate re-scheduling) all feed into the scheduler to trigger node processing cycles.

Key Components

// Build a computation graph
let processor = NodeBuilder::new(State::new())
    .triggered_by(&data_source)     // Execute when source changes
    .observer_of(&config_node)      // Read config but don't auto-execute
    .with_name("processor".into())
    .build(&mut executor, |state: &mut State, ctx: &mut ExecutionContext| {
        // Process data with mutable access to state
        state.process(data_source.borrow().latest_data());
        Control::Broadcast  // Notify downstream nodes
    });

Features

Wavelet uses Cargo features to enable different functionality:

runtime (default) - Core execution engine including the scheduler, computation graph, event drivers (I/O, timer, yield), and garbage collection. This provides the fundamental stream processing capabilities.
factories - Domain-specific language (DSL) primitives and dependency injection system for building complex computation graphs. Factories enable you to construct reusable subgraphs that return leaf nodes, with automatic memoization to prevent duplicate node creation. This is essential for building sophisticated topologies where the same subgraph patterns are reused across multiple downstream dependencies.
testing - Comprehensive test utilities and mock implementations designed for unit testing individual nodes and entire computation graphs. Includes test clocks and mock event sources for validating node behavior in isolation.
channel - Cross-thread communication infrastructure using lock-free ring buffers (crossbeam's ArrayQueue) integrated with mio notifications (Notifier). This enables external threads and systems to inject data into the computation graph safely and efficiently.
full - Convenience feature that enables all available functionality. Equivalent to enabling runtime, factories, testing, and channel features simultaneously.

[dependencies]
wavelet = { version = "0.1.3", features = ["full"] }

Dependency Injection with Factories

Wavelet's factory system enables environment-specific implementations while maintaining identical graph topology. Factories provide build-time dependency injection, allowing you to swap implementations based on configuration without changing your core processing logic.

Simple Factory Usage

use wavelet::factories::*;

// Configure different data sources per environment
let data_source = match environment {
    Environment::Production => KeyedFactory::default()
        .attach(|executor, symbol| create_live_feed(executor, symbol)),
    Environment::Test => KeyedFactory::default()
        .attach(|executor, symbol| create_mock_feed(executor, symbol)),
    Environment::Replay => KeyedFactory::default()
        .attach(|executor, symbol| create_historical_feed(executor, symbol, date_range)),
};

// Same graph construction code works with any configured factory
let eurusd_feed = data_source.get(&mut executor, "EURUSD".to_string());
let gbpusd_feed = data_source.get(&mut executor, "GBPUSD".to_string());

// Build downstream processors using the factory-created nodes
let processor = NodeBuilder::new(PriceProcessor::new())
    .triggered_by(&eurusd_feed)  // Implementation determined by factory
    .triggered_by(&gbpusd_feed)
    .build(&mut executor, process_prices);

Composable Factory Patterns

For complex topologies, compose simple factories into larger DSL structures:

// DSL-level factories (custom structs)
struct MarketDataFactory { /* configuration */ }
struct RiskEngineFactory { /* configuration */ }  
struct OrderGatewayFactory { /* configuration */ }

impl MarketDataFactory {
    fn get_feed(&self, executor: &mut Executor, symbol: String) -> Node<MarketFeed> {
        // Implementation specific to market data
    }
}

// Strategy factory composes DSL factories with a KeyedFactory
struct StrategyFactory {
    market_data: MarketDataFactory,
    risk_engine: RiskEngineFactory, 
    order_gateway: OrderGatewayFactory,
    strategies: KeyedFactory<String, Strategy>,
}

impl StrategyFactory {
    fn for_environment(env: Environment) -> Self {
        // Create DSL component factories
        let market_data = MarketDataFactory::for_environment(env);
        let risk_engine = RiskEngineFactory::for_environment(env);
        let order_gateway = OrderGatewayFactory::for_environment(env);

        // Create the KeyedFactory that builds complete strategies
        let strategies = {
            let market_data = market_data.clone();
            let risk_engine = risk_engine.clone(); 
            let order_gateway = order_gateway.clone();
            
            KeyedFactory::default().attach(move |executor, symbol: &String| {
                // Use DSL factories to build the subgraph
                let feed = market_data.get_feed(executor, symbol.clone());
                let risk = risk_engine.get_validator(executor, "primary".to_string());
                let gateway = order_gateway.get_sender(executor, symbol.clone());
                
                // Return the leaf node of this subgraph
                NodeBuilder::new(Strategy::new(symbol.clone()))
                    .triggered_by(&feed)
                    .observer_of(&risk)    // Risk provides validation
                    .observer_of(&gateway) // Gateway handles execution
                    .build(executor, |strategy, ctx| {
                        // Strategy logic here
                        Control::Broadcast
                    })
            })
        };

        Self {
            market_data,
            risk_engine,
            order_gateway,
            strategies,
        }
    }
    
    fn get_strategy(&self, executor: &mut Executor, symbol: String) -> Node<Strategy> {
        self.strategies.get(executor, symbol)
    }
}

// Usage: DSL factories compose into higher-level factories
let factory = StrategyFactory::for_environment(config.environment);
let eurusd_strategy = factory.get_strategy(&mut executor, "EURUSD".to_string());
let gbpusd_strategy = factory.get_strategy(&mut executor, "GBPUSD".to_string());

Key Benefits

Memoization: Identical keys return the same cached node instance, preventing duplicate subgraph creation
Environment Isolation: Test, staging, and production can use completely different implementations
Resource Efficiency: Expensive resources (database connections, external APIs) are created once per key
Type Safety: Factory functions are statically typed, preventing configuration errors
Composability: Simple factories combine into complex domain-specific languages (DSLs)

This pattern is particularly powerful for financial systems, IoT processing pipelines, and any domain where you need to swap data sources, validation logic, or output destinations based on runtime configuration.

License

MIT License (LICENSE)

Adding wavelet library as a dependency

Adding `wavelet` library as a dependency