freenet-scaffold 0.2.2

Support library for building Freenet 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

pub mod convergence;
pub mod util;

pub use freenet_scaffold_macro::*;
use serde::de::DeserializeOwned;
use serde::Serialize;
use std::fmt::Debug;

pub trait ComposableState {
    type ParentState: Serialize + DeserializeOwned + Clone + Debug;
    type Summary: Serialize + DeserializeOwned + Clone + Debug;
    type Delta: Serialize + DeserializeOwned + Clone + Debug;
    type Parameters: Serialize + DeserializeOwned + Clone + Debug;

    fn verify(
        &self,
        parent_state: &Self::ParentState,
        parameters: &Self::Parameters,
    ) -> Result<(), String>;
    fn summarize(
        &self,
        parent_state: &Self::ParentState,
        parameters: &Self::Parameters,
    ) -> Self::Summary;
    fn delta(
        &self,
        parent_state: &Self::ParentState,
        parameters: &Self::Parameters,
        old_state_summary: &Self::Summary,
    ) -> Option<Self::Delta>;

    /// Applies the specified `delta` to the current state.
    ///
    /// If delta is None then this function should still make any changes that might be
    /// required based on other fields in the parent_state which may have changed.
    fn apply_delta(
        &mut self,
        parent_state: &Self::ParentState,
        parameters: &Self::Parameters,
        delta: &Option<Self::Delta>,
    ) -> Result<(), String>;

    /// Merges the current state with another state.
    fn merge(
        &mut self,
        parent_state: &Self::ParentState,
        parameters: &Self::Parameters,
        other_state: &Self,
    ) -> Result<(), String> {
        let my_summary = self.summarize(parent_state, parameters);
        let delta_in = other_state.delta(parent_state, parameters, &my_summary);
        self.apply_delta(parent_state, parameters, &delta_in)?;
        Ok(())
    }
}

#[cfg(test)]
mod tests;