mpstthree 0.1.17

A library implementing Multiparty Session Types for 2 or more participants
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

//! This module contains the macros for
//! creating the different structures and
//! associated functions for any number
//! of participants to simplify send/recv.

/// Create a new SessionMST structure, new roles and the baking environment.
/// This macro creates the related `fork_mpst` function.
///
/// # Arguments
///
/// * Type of generate (basic, recursive, cancel, rec_and_cancel, interleaved)
/// * Name of the new SessionMST
/// * Names of the new roles. They are called as RoleX where X is the name provided.
///
/// # Basic examples
///
/// ## Basic
///
/// ```
/// use mpstthree::generate;
///
/// generate!("basic", MeshedChannels, A, B, C);
/// ```
///
/// ## Recursive
///
/// Also create the macros needed for choosing branches.
/// Each macro is linked to a role X and are called as followed:
///     choose_mpst_x_to_all!(
///         s, # the current session
///         enum_1::variant_1, # the first branch for the first passive role
///         enum_2::variant_2, # the first branch for the second passive role
///         ...
///         enum_n::variant_n, # the first branch for the n-th passive role
///     )
/// This macro creates the related `fork_mpst` function.
///
/// ```
/// use mpstthree::generate;
///
/// generate!("recursive", MeshedChannels, A, B, C);
/// ```
///
/// ## Cancel
///
/// Also creates the primitives to handle an additional monitor that
/// checks the health of each participant and broadcasts any failure.
///
/// ```
/// use mpstthree::generate;
///
/// generate!("cancel", MeshedChannels, A, B, C);
/// ```
///
/// ## Rec and Cancel
///
/// Also create the macros needed for choosing branches.
/// Each macro is linked to a role X and are called as followed:
///     choose_mpst_x_to_all!(
///         s, # the current session
///         enum_1::variant_1, # the first branch for the first passive role
///         enum_2::variant_2, # the first branch for the second passive role
///         ...
///         enum_n::variant_n, # the first branch for the n-th passive role
///     )
/// This macro creates the related `fork_mpst` function.
///
/// ```
/// use mpstthree::generate;
///
/// generate!("rec_and_cancel", MeshedChannels, A, B, C);
/// ```
///
/// ## Interleaved
///
/// Also create the macros needed for interleaved sessions
/// (sessions where one participant is involved in two different
/// protocols)
///
/// ```
/// use mpstthree::generate;
///
/// generate!(
///     "interleaved",
///     MeshedChannels,
///     Barber,
///     ShopBarber,
///     2,
///     MeshedChannels,
///     Client,
///     ShopClient,
///     2,
///     fork_mpst
/// );
/// ```
#[macro_export]
#[cfg_attr(doc_cfg, doc(cfg(feature = "baking")))]
macro_rules! generate {
    (
        "basic",
        $meshedchannels_name: ident,
        $( $all_roles: ident ),+ $(,)?
    ) => {
        mpst_seq_proc::baking!(
            $meshedchannels_name ,
            $( $all_roles , )+
        );
    };
    (
        "recursive",
        $meshedchannels_name: ident,
        $( $all_roles: ident ),+ $(,)?
    ) => {
        mpst_seq_proc::baking_with_enum!(
            $meshedchannels_name ,
            $( $all_roles , )+
        );
    };
    (
        "cancel",
        $meshedchannels_name: ident,
        $( $all_roles: ident ),+ $(,)?
    ) => {
        mpst_seq_proc::baking_with_cancel!(
            $meshedchannels_name ,
            $( $all_roles , )+
        );
    };
    (
        "rec_and_cancel",
        $meshedchannels_name: ident,
        $( $all_roles: ident ),+ $(,)?
    ) => {
        mpst_seq_proc::baking_with_enum_and_cancel!(
            $meshedchannels_name ,
            $( $all_roles , )+
        );
    };
    (
        "interleaved",
        $meshedchannels_name_one: ident,
        $( $all_roles_one: ident , )+
        $index_tuple_one: literal,
        $meshedchannels_name_two: ident,
        $( $all_roles_two: ident , )+
        $index_tuple_two: literal,
        $func_name: ident
    ) => {
        mpst_seq_proc::baking_interleaved_with_enum_and_cancel!(
            $meshedchannels_name_one ,
            ( $( ( $all_roles_one ) )+ ) ,
            $index_tuple_one ,
            $meshedchannels_name_two ,
            ( $( ( $all_roles_two ) )+ ) ,
            $index_tuple_two ,
            $func_name
        );
    };
    (
        "atmp_interleaved",
        $meshedchannels_name_one: ident,
        $( $all_roles_one: ident , )+
        $index_tuple_one: literal,
        $meshedchannels_name_two: ident,
        $( $all_roles_two: ident , )+
        $index_tuple_two: literal,
        $func_name: ident
    ) => {
        mpst_seq_proc::baking_atmp_interleaved_with_enum_and_cancel!(
            $meshedchannels_name_one ,
            ( $( ( $all_roles_one ) )+ ) ,
            $index_tuple_one ,
            $meshedchannels_name_two ,
            ( $( ( $all_roles_two ) )+ ) ,
            $index_tuple_two ,
            $func_name
        );
    };
}