rs-store 0.15.0

Redux Store for Rust
Documentation

rs-store

Crates.io Documentation License: MIT

A thread-safe Redux-style state management library implemented in Rust.

Overview

rs-store provides a predictable state container inspired by Redux, featuring thread-safe state management with support for reducers, subscribers, and async actions through Thunk. Unlike traditional Redux, rs-store's reducers can produce side effects, providing more flexibility in state management.

Features

  • ๐Ÿ”’ Thread-safe state management
  • ๐Ÿ“ข Publisher/Subscriber pattern for state changes
  • ๐Ÿ”„ Support for async operations via Thunk actions
  • ๐Ÿ“Š Side effect handling in reducers
  • ๐Ÿ“Š Backpressure handling with configurable policies
  • ๐ŸŽฏ Bounded channel size with sync channels
  • ๐Ÿงช Comprehensive test coverage

Installation

Add this to your Cargo.toml:

[dependencies]
rs-store = "0.15.0"

Quick Start

use rs_store::{Store, CalcState, CalcAction, CalcReducer, CalcSubscriber};
use std::{thread, sync::Arc};

impl Reducer<CalcState> for CalcReducer {
    fn reduce(&self, state: &CalcState, action: &CalcAction) -> DispatchOp<CalcState, CalcAction> {
        match action {
            CalcAction::Add(value) => {
                println!("Adding value: {}", value);
                DispatchOp::Dispatch(
                    CalcState {
                        value: state.value + value,
                    },
                    None,
                )
            }
            CalcAction::Subtract(value) => {
                println!("Subtracting value: {}", value);
                DispatchOp::Dispatch(
                    CalcState {
                        value: state.value - value,
                    },
                    None,
                )
            }
        }
    }
}

fn main() {
    // Initialize store with default reducer
    let store = Store::<CalcState, CalcAction>::new(Box::new(CalcReducer::default()));

    // Add subscriber
    store.add_subscriber(Arc::new(CalcSubscriber::default()));

    // Dispatch action
    store.dispatch(CalcAction::Add(1));

    thread::sleep(std::time::Duration::from_secs(1));
    // add more subscriber
    store.add_subscriber(Arc::new(CalcSubscriber::default()));

    // Dispatch action
    store.dispatch(CalcAction::Subtract(1));

    // Clean up
    store.stop();
}

Side Effects in Reducers

Unlike traditional Redux implementations, rs-store allows reducers to produce side effects directly. This means reducers can produce asynchronous operations.

This design choice provides more flexibility while maintaining predictable state management.

Documentation

For detailed documentation, visit:

Implementation Status

Completed โœ…

  • Reducer with side effects support
  • Thread naming support
  • Subscription management (subscribe/unsubscribe)
  • Subscriber clearing functionality
  • Thunk action support
  • Backpressure policy (drop oldest)
  • Bounded channel size implementation
  • Test coverage

In Progress ๐Ÿšง

  • Latest state notification for new subscribers
  • Notification scheduler (CurrentThread, ThreadPool)
  • Stream-based pull model
  • Stats middleware for state change logging

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.