MagicStateMachines 0.1.0

Ergonomic typestate wrappers for compiler-enforced state machines with separable contracts
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

use crate::{
    SMut, SRef, State, StateMachineImpl, StateStorage, StateTrait, StateUnionDiscriminant,
};
use core::marker::PhantomData;
use core::ops::{Deref, DerefMut};

/// A state receiver carrying an unresolved generated transition proof.
#[doc(hidden)]
pub struct StateWithProof<Storage, T, From, Proof>
where
    T: StateMachineImpl,
    Storage: StateStorage,
{
    pub(crate) state: State<Storage, T, From>,
    pub(crate) proof: Proof,
}

/// A state receiver carrying a generated union-transition proof.
#[doc(hidden)]
pub struct StateUnionProvenState<Storage, T, From, Marker, To>
where
    T: StateMachineImpl,
    Storage: StateStorage,
    From: StateTrait,
    Marker: StateUnionDiscriminant,
    To: StateTrait,
{
    pub(crate) state: State<Storage, T, From>,
    pub(crate) marker: PhantomData<fn() -> (Marker, To)>,
}

/// A state receiver carrying a generated concrete-transition proof.
#[doc(hidden)]
pub struct StateConcreteProvenState<Storage, T, From, Marker, To>
where
    T: StateMachineImpl,
    Storage: StateStorage,
    From: StateTrait,
    Marker: StateUnionDiscriminant,
    To: StateTrait,
{
    pub(crate) state: State<Storage, T, From>,
    pub(crate) marker: PhantomData<fn() -> (Marker, To)>,
}

impl<Storage, T, From, Marker, To> Deref for StateUnionProvenState<Storage, T, From, Marker, To>
where
    T: StateMachineImpl,
    Storage: SRef,
    From: StateTrait,
    Marker: StateUnionDiscriminant,
    To: StateTrait,
{
    type Target = T;

    fn deref(&self) -> &Self::Target {
        Storage::s_ref(&self.state.inner)
    }
}

impl<Storage, T, From, Marker, To> DerefMut for StateUnionProvenState<Storage, T, From, Marker, To>
where
    T: StateMachineImpl,
    Storage: SMut,
    From: StateTrait,
    Marker: StateUnionDiscriminant,
    To: StateTrait,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        Storage::s_mut(&mut self.state.inner)
    }
}

impl<Storage, T, From, Marker, To> Deref for StateConcreteProvenState<Storage, T, From, Marker, To>
where
    T: StateMachineImpl,
    Storage: SRef,
    From: StateTrait,
    Marker: StateUnionDiscriminant,
    To: StateTrait,
{
    type Target = T;

    fn deref(&self) -> &Self::Target {
        Storage::s_ref(&self.state.inner)
    }
}

impl<Storage, T, From, Marker, To> DerefMut
    for StateConcreteProvenState<Storage, T, From, Marker, To>
where
    T: StateMachineImpl,
    Storage: SMut,
    From: StateTrait,
    Marker: StateUnionDiscriminant,
    To: StateTrait,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        Storage::s_mut(&mut self.state.inner)
    }
}