amethystate 0.11.0

Type-safe reactive persistence for Rust GUI apps
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
125
126
127
128
129
130
131
132
133
134
135
136

use amethystate::store::builder::StoreBuilder;
use amethystate::{AmeType, ReactiveMap, amethystate};
use amethystate_core::test_utils::unique_path;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, AmeType)]
pub struct Limits {
    pub warning: u64,
}

#[amethystate(prefix = "dbg")]
pub struct Settings {
    #[amestate(default = 8080)]
    pub port: u16,

    #[amestate(default = "dark".to_string())]
    pub theme: String,

    #[amestate(default = { "cpu": Limits { warning: 70 } })]
    pub limits: ReactiveMap<String, Limits>,
}

/// Deliberately not `Debug`: the framework must not demand it.
#[derive(Clone, Default, PartialEq, Serialize, Deserialize, AmeType)]
pub struct Opaque {
    pub inner: u8,
}

#[amethystate(prefix = "dbg_opaque")]
pub struct HasOpaque {
    #[amestate(default = 1)]
    pub port: u16,

    #[amestate(default = Opaque { inner: 7 })]
    pub opaque: Opaque,
}

fn assert_debug<T: std::fmt::Debug>() {}

#[test]
fn a_field_type_need_not_be_printable() {
    let store = StoreBuilder::new(unique_path("dbg_opaque"))
        .build()
        .unwrap();
    let state = HasOpaque::new_with(&store).unwrap();

    assert_eq!(state.opaque().get().inner, 7);
    assert_eq!(state.port().get(), 1);
}

#[test]
fn a_printable_struct_still_gets_its_impl() {
    assert_debug::<Settings>();
}

fn settings(tag: &str) -> Settings {
    let store = StoreBuilder::new(unique_path(tag)).build().unwrap();
    Settings::new_with(&store).unwrap()
}

#[test]
fn a_field_shows_its_path_and_value() {
    let state = settings("dbg_field");
    let shown = format!("{:?}", state.port());

    assert!(shown.contains("Field"), "{shown}");
    assert!(shown.contains("dbg.port"), "{shown}");
    assert!(shown.contains("8080"), "{shown}");
}

#[test]
fn a_field_shows_the_current_value_not_the_default() {
    let state = settings("dbg_current");
    state.port().set(9090).unwrap();

    let shown = format!("{:?}", state.port());
    assert!(shown.contains("9090"), "{shown}");
    assert!(!shown.contains("8080"), "{shown}");
}

#[test]
fn a_state_struct_shows_every_field_by_name() {
    let state = settings("dbg_struct");
    let shown = format!("{state:?}");

    assert!(shown.starts_with("Settings {"), "{shown}");
    for expected in ["port", "8080", "theme", "dark", "limits", "cpu", "70"] {
        assert!(shown.contains(expected), "missing {expected} in {shown}");
    }
}

#[test]
fn the_instance_id_stays_out_of_the_output() {
    let state = settings("dbg_no_id");
    let shown = format!("{state:?}");

    assert!(
        !shown.contains("__amethystate_instance_id"),
        "internals leaked: {shown}"
    );
}

#[amethystate(prefix = "dbg_p_opaque", mode = "persistent")]
pub struct PersistentOpaque {
    #[amestate(default = Opaque { inner: 3 })]
    pub opaque: Opaque,
}

#[derive(Debug)]
#[amethystate(prefix = "dbg_p_shown", mode = "persistent")]
pub struct PersistentShown {
    #[amestate(default = 5)]
    pub port: u16,
}

#[test]
fn a_persistent_struct_needs_no_debug_either() {
    let store = StoreBuilder::new(unique_path("dbg_p_opaque"))
        .build()
        .unwrap();
    let state = PersistentOpaque::load_with(&store).unwrap();

    assert_eq!(state.opaque.inner, 3);
}

#[test]
fn a_persistent_struct_prints_when_asked() {
    let store = StoreBuilder::new(unique_path("dbg_p_shown"))
        .build()
        .unwrap();
    let state = PersistentShown::load_with(&store).unwrap();

    let shown = format!("{state:?}");
    assert!(shown.contains("PersistentShown"), "{shown}");
    assert!(shown.contains("5"), "{shown}");
}