amethystate 0.26.0

A state manager for Rust applications
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

//! Persistent reactive state for Rust GUI apps.

#![allow(clippy::complexity)]
#![deny(rustdoc::broken_intra_doc_links)]
#![cfg_attr(
    not(any(
        feature = "redb",
        feature = "sqlite",
        feature = "json",
        feature = "toml",
        feature = "ron"
    )),
    allow(dead_code, unused_imports, unused_variables, unreachable_code)
)]
mod codec;
mod global;
mod macros;

pub mod migration;
pub mod observability;
pub mod reactive;
pub mod schema;
pub mod shape;
pub mod store;

pub type AmeData<T> = <T as AmeState>::Data;

/// What a migration step answers with: everything it can fail at, and nothing
/// else.
pub type MigrationResult<T> = crate::migration::StepResult<T>;

pub use erased_serde;
pub use error_stack;
pub use indexmap;
pub use inventory;
pub use serde;
pub use uuid;

pub use reactive::{
    AmeState, AmeStateNode, Change, Field, Id, MapChange, ReactiveCell, ReactiveMap,
    ReactiveMapKey, ReactiveMapValue, ReactiveScope, SignalSubscription,
};
pub use store::StoreSubscription;

pub mod errors {
    pub use crate::codec::CodecError;
    pub use crate::reactive::error::{
        FieldError, ReactiveFieldResult, ReactiveMapError, ReactiveMapResult, WriteResult,
        WriteValue,
    };
    pub use crate::store::StorageError;
    pub use amethystate_core::facts;
    pub use amethystate_core::failure::{Because, Caused};
    pub use error_stack::Report;
}
pub mod stores {
    pub use crate::store::default::*;
}

pub use store::{
    AmeStateSlice, Open, Schema, StateScope, StorageResult, StoreEvent, StoreOp, SubscriptionKind,
    builder::StoreBuilder, config::StoreConfig, default::Store,
};

pub use migration::{MigrationContext, MigrationError, MigrationPlan, MigrationReport};

pub use amethystate_macros::{amethystate, migrate};

pub mod prelude;
pub use global::*;

#[cfg(feature = "json")]
pub use serde_json;
pub use store::StoreBackend;
pub use store::StoreExt;

#[cfg(any(feature = "test-utils", test))]
pub mod test_utils;

#[cfg(feature = "async")]
pub mod client {
    pub use amethystate_core::AmeBackendAsync;
    pub use amethystate_core::AmeStateSliceAsync;
    pub use amethystate_core::async_impl::*;
    pub use amethystate_core::{FieldCore, ReactiveMapCore};

    use amethystate_core::async_impl::Field as CoreField;
    use amethystate_core::async_impl::ReactiveMap as CoreReactiveMap;

    pub type ReactiveMap<K, V, B> = CoreReactiveMap<K, V, B>;

    pub type Field<V, B> = CoreField<V, B>;
}