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

#![cfg(feature = "role")]

//! The main trait used for representing an ordering or the
//! name of a participant.
//!
//! Every structure that relies on this trait, such as
//! [`RoleA`] and
//! [`RoleB`], contains at
//! least a parameter, which is a [`Role`]
//! itself. The only exception is
//! [`RoleEnd`], which represents
//! the end of any ordering.
//!
//! [`Role`]: crate::role::Role
//! [`RoleEnd`]: crate::role::end::RoleEnd
//! [`RoleA`]: crate::role::a::RoleA
//! [`RoleB`]: crate::role::b::RoleB

pub mod a;
pub mod a_dual;
pub mod a_to_all;
pub mod all_to_a;
pub mod all_to_b;
pub mod all_to_c;
pub mod b;
pub mod b_dual;
pub mod b_to_all;
pub mod broadcast;
pub mod c;
pub mod c_dual;
pub mod c_to_all;
pub mod end;
use std::marker;

/// Trait for session types. Provides duality.
pub trait Role: marker::Sized + marker::Send {
    /// The Role type dual to `Self`.
    type Dual: Role<Dual = Self>;

    // Creates two new *dual* roles.
    //
    // The `new` function is used internally in this library to
    // define functions such as
    // [`fork_simple`](crate::fork::fork_simple). The `Dual` is often
    // unused, but may be necessary for specific cases, such as
    // closing a connection.
    #[doc(hidden)]
    fn new() -> (Self, Self::Dual);

    #[doc(hidden)]
    fn head_str() -> String;

    #[doc(hidden)]
    fn tail_str() -> String;

    #[doc(hidden)]
    fn self_head_str(&self) -> String;

    #[doc(hidden)]
    fn self_tail_str(&self) -> String;
}