oxide_core 0.4.0

Rust engine primitives for Oxide (store, snapshot streams, error model, optional persistence).
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

#![doc = include_str!("../README.md")]

// Crate entrypoint and stable public surface.
//
// Why: Oxide needs a small, usage-agnostic Rust core that can be consumed from
// multiple environments (native, WASM, and Flutter Rust Bridge) without leaking
// internal module structure into public imports.
//
// How: Keep internal modules organized by responsibility and re-export the
// user-facing types from this file so refactors remain non-breaking.
mod engine;

#[cfg(feature = "navigation-binding")]
/// Typed navigation primitives (Rust-driven, Flutter-native).
pub mod navigation;

#[cfg(feature = "isolated-channels")]
/// Transport-only typed Rust ↔ Dart channels.
pub mod isolated_channels;

/// FFI-oriented utilities.
pub mod ffi;

/// Async runtime utilities backed by Flutter Rust Bridge.
pub mod runtime;

#[cfg(feature = "state-persistence")]
/// Optional state persistence utilities.
pub mod persistence;

pub use engine::InitContext;
pub use engine::{
    CoreResult, OxideError, Reducer, ReducerEngine, SlicedState, StateChange, StateSnapshot,
};
pub use engine::Context;
pub type ReducerCtx<'a, Input, State, StateSlice = ()> =
    engine::Context<'a, Input, State, StateSlice>;

/// Initializes global runtimes used by optional Oxide features.
///
/// Why: some features (navigation, isolated channels) use explicit global singletons for
/// generated glue code. This helper provides a single, idempotent entry point to initialize
/// all enabled globals consistently.
pub fn init_engine_globals() -> CoreResult<()> {
    #[cfg(feature = "navigation-binding")]
    {
        engine::init_navigation()?;
    }

    #[cfg(feature = "isolated-channels")]
    {
        isolated_channels::init_isolated_channels()?;
    }

    Ok(())
}

#[cfg(feature = "frb-spawn")]
pub fn init_from_frb(thread_pool_provider: fn() -> runtime::ThreadPool) -> CoreResult<()> {
    let _ = runtime::init(thread_pool_provider);
    init_engine_globals()?;
    Ok(())
}

#[cfg(not(feature = "frb-spawn"))]
pub fn init_from_frb(_thread_pool_provider: fn() -> ()) -> CoreResult<()> {
    runtime::ensure_initialized()?;
    init_engine_globals()?;
    Ok(())
}

#[cfg(feature = "navigation-binding")]
pub use engine::{
    NavigationCtx, NavigationRuntime, init_navigation, navigation_runtime,
};

#[cfg(feature = "isolated-channels")]
pub use isolated_channels::{
    CallbackRuntime, EventChannelRuntime, IncomingHandler, OxideCallbacking, OxideChannelError,
    OxideChannelResult, OxideEventChannel, OxideEventDuplexChannel, ensure_isolated_channels_initialized,
    init_isolated_channels, isolated_channels_initialized, isolated_channels_runtime,
    OxideIsolatedChannelsRuntime,
};
pub use ffi::watch_receiver_to_stream;
pub use tokio;

#[cfg(any(feature = "state-persistence", feature = "navigation-binding"))]
pub use serde;

#[cfg(test)]
mod tests;