rust-elm 0.9.0

Elm Architecture for Rust: composable reducers, pure effects, async runtime.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! # rust-elm
//!
//! A Rust port of The Elm Architecture
//!
//! - **Pure descriptions**: `Cmd`, `Effect`, and `Sub` are data — interpretation lives in [`Runtime`] (requires `runtime` feature).
//! - **Zero-cost updates**: `update` uses fn pointers; no `Box<dyn Fn>` on hot paths.
//! - **Composition**: [`Slot`](component::Slot), [`optics`](optics), [`Reducer`](reducer::Reducer) / `CombineReducers`.
//!
//! ## Source layout
//!
//! | Directory | Role |
//! |-----------|------|
//! | [`core/`](core) | `Cmd`, `Effect`, `Sub`, `Program`, `bus` — pure data |
//! | [`compose/`](compose) | `Reducer`, `ScopeReducer`, `safe_reducer`, optics |
//! | [`infra/`](infra) | `Environment`, `Shared`, replay |
//! | [`runtime/`](runtime) | Store, Tokio interpreter, subscriptions (`runtime` feature) |
//! | [`testing/`](testing) | `TestRuntime`, `ExhaustiveTestStore`, macros |

#![allow(
    non_snake_case,
    unpredictable_function_pointer_comparisons,
)]

pub mod compose;
pub mod core;
pub mod infra;
#[cfg(feature = "runtime")]
pub mod runtime;
pub mod testing;

// Flat re-exports — stable public API.
pub use core::{batch, bus, cmd, effect, error, interp, program, sub};
pub use compose::{component, optics, reducer, safe_reducer, scope};
pub use infra::{env, replay, shared};
pub use testing::{macros, test_runtime, test_support};
#[cfg(feature = "runtime")]
pub use testing::test_store;
#[cfg(feature = "runtime")]
pub use runtime::{store, subscription};

/// Re-export keypath types for state/action focusing (see `optics`).
pub mod keypath {
pub use key_paths_core::{FieldDiff, hash_value, KeyPath, KpTrait, Readable, RefKpTrait, Writable};
    pub use rust_key_paths::{EnumKp, EnumKpType, EnumValueKpType, Kp};
}

pub use batch::batch;
pub use bus::{Bus, BusSender};
pub use cmd::Cmd;
pub use component::{lift, Slot};
pub use effect::{Effect, EffectId, EnvTaskFn, RunSender, TaskFn};
pub use dependencies::{
    Clock, ClockDep, ClockKey, DepRng, DependencyError, DependencyKey, DependencyValues,
    LiveRng, LiveUuidGen, Now, NowDep, NowKey, RealClock, RngDep, RngKey, SeededRng,
    SeededUuidGen, TestClock, TestNow, UuidDep, UuidGen, UuidKey,
};
pub use rust_dependencies as dependencies;
pub use env::{defer_batch, Environment, FakeClock, MockHttp};
pub use error::EffectError;
pub use interp::{flatten_effects, normalize, InterpretCtx};
pub use rust_identified_vec::{Identifiable, IdentifiedVec};
pub use optics::{
    enum_err, enum_ok, enum_some, enum_variant, variant_of, CasePath, Casepath, EnumKp,
    EnumKpType, EnumValueKpType, Kp,
};
pub use program::{Program, ReducerProgram};
pub use safe_reducer::{safe_reduce_rollback, safe_reduce_update, SafeReduceError};
pub use reducer::{coerce_fn, CatchReducer, CombineReducers, Reduce, Reducer, RollbackCatchReducer};
pub use replay::{ReplayHarness, ReplayLog};
#[cfg(feature = "serde")]
pub use replay::StateSnapshot;
#[cfg(feature = "runtime")]
pub use runtime::{Runtime, RuntimeConfig, RuntimeError, RwRuntime, TeaRuntime};
#[cfg(all(feature = "runtime", feature = "arc-swap"))]
pub use runtime::SwapRuntime;
pub use scope::{
    lift_cmd, lift_cmd_with_id, ForEachReducer, IfCaseLetReducer, IfLetReducer, OptionalReducer,
    ScopeReducer,
};
pub use shared::{InMemoryStorage, Shared, SharedSubscriber, Storage, StorageError};
#[cfg(feature = "serde")]
pub use shared::FileStorage;
#[cfg(feature = "runtime")]
pub use store::{
    ChangeSet, ChangeSubscriber, ScopedChangeSubscriber, ScopedStore, StateSubscriber, Store,
    StoreTask, StoreTaskError,
};
#[cfg(feature = "runtime")]
pub use runtime::rw_store::{
    ReadStore, RwChangeSubscriber, RwStateSubscriber, RwStore, ScopedRwStore,
};
#[cfg(feature = "runtime")]
pub use runtime::tea_store::{
    ScopedTeaStore, ScopedTeaStateSubscriber, TeaChangeSubscriber, TeaStateSubscriber, TeaStore,
    TeaStoreError, TeaViewStore,
};
#[cfg(all(feature = "runtime", feature = "arc-swap"))]
pub use runtime::swap_store::{
    ScopedSwapStore, SnapshotStore, SwapChangeSubscriber, SwapStateSubscriber, SwapStore,
};
pub use runtime::binding::{
    ComposedBinding, ProjectedBinding, ReadProjectedBinding, ReadStateBinding,
    RwProjectedBinding, RwStateBinding, StateBinding,
};
#[cfg(feature = "arc-swap")]
pub use runtime::binding::{SnapshotProjectedBinding, SnapshotStateBinding};
pub use sub::Sub;
pub use test_runtime::TestRuntime;
#[cfg(feature = "runtime")]
pub use test_store::{ExhaustiveTestStore, TestStoreError};
pub use test_support::{
    allow_state_clones, on_state_clone, replay_snapshot, shared_get, shared_with_mut,
    start_reducer_runtime, start_runtime, start_rw_reducer_runtime, start_tea_reducer_runtime,
};
#[cfg(all(feature = "runtime", feature = "arc-swap"))]
pub use test_support::start_swap_reducer_runtime;
#[cfg(feature = "runtime")]
pub use test_support::{
    scoped_child_state, scoped_subscribe_state, scoped_subscriber_next, store_state,
    subscribe_state, subscriber_wait_next,
};

pub use rust_key_paths;
pub use key_paths_core;