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

//! This module contains all the macros that are used for
//! the parametrisation on the number of
//! participants.
//!
//! They main ones are[`create_normal_role`] and
//! [`create_meshedchannels`]
//!
//! [`create_normal_role`]: crate::create_normal_role
//! [`create_meshedchannels`]: crate::create_meshedchannels
//!
//! *This module is available only if MultiCrusty is built with
//! the `"macros_multiple"` feature.*

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod cancel;

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod choose;

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod close;

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod fork;

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod meshedchannels;

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod offer;

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod recv;

#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
pub mod send;

/// Creates the structure MeshedChannels
/// [`create_meshedchannels`],
/// the [`close_mpst`] and [`fork_mpst_multi`].
///
/// # Arguments
///
/// * The name of the new *close* function
/// * The name of the new *fork* function
/// * The name of the *MeshedChannels* type that will be used
/// * The number of participants (all together)
///
/// # Example
///
/// ```
/// use mpstthree::bundle_struct_fork_close_multi;
///
/// bundle_struct_fork_close_multi!(close_mpst, fork_mpst, MeshedChannels, 3);
/// ```
///
/// [`create_meshedchannels`]: crate::create_meshedchannels
/// [`close_mpst`]: crate::close_mpst
/// [`fork_mpst_multi`]: crate::fork_mpst_multi
///
/// *This macro is available only if MultiCrusty is built with
/// the `"macros_multiple"` feature.*
#[macro_export]
#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
macro_rules! bundle_struct_fork_close_multi {
    (
        $func_name_close:ident,
        $func_name_fork:ident,
        $meshedchannels_name:ident,
        $n_sessions:literal
    ) => {
        mpstthree::create_meshedchannels!($meshedchannels_name, $n_sessions);
        mpstthree::close_mpst!($func_name_close, $meshedchannels_name, $n_sessions);
        mpstthree::fork_mpst_multi!($func_name_fork, $meshedchannels_name, $n_sessions);
    };
}

/// Creates the structure MeshedChannels
/// [`create_meshedchannels`],
/// the [`close_mpst_cancel`] and
/// [`fork_mpst_multi`]
/// functions to be used with more than 2 participants.
/// It checks the send sides of the channels along the recv sides.
///
/// # Arguments
///
/// * The name of the new *close* function
/// * The name of the new *fork* function
/// * The name of the *MeshedChannels* type that will be used
/// * The number of participants (all together)
///
/// # Example
///
/// ```
/// use mpstthree::bundle_struct_fork_close_multi_cancel;
///
/// bundle_struct_fork_close_multi_cancel!(close_mpst, fork_mpst, MeshedChannels, 3);
/// ```
///
/// [`create_meshedchannels`]: crate::create_meshedchannels
/// [`close_mpst_cancel`]: crate::close_mpst_cancel
/// [`fork_mpst_multi`]: crate::fork_mpst_multi
///
/// *This macro is available only if MultiCrusty is built with
/// the `"macros_multiple"` feature.*
#[macro_export]
#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
macro_rules! bundle_struct_fork_close_multi_cancel {
    (
        $func_name_close:ident,
        $func_name_fork:ident,
        $meshedchannels_name:ident,
        $n_sessions:literal
    ) => {
        mpstthree::create_meshedchannels!($meshedchannels_name, $n_sessions);
        mpstthree::close_mpst_cancel!($func_name_close, $meshedchannels_name, $n_sessions);
        mpstthree::fork_mpst_multi!($func_name_fork, $meshedchannels_name, $n_sessions);
    };
}