telltale-machine 17.0.0

Protocol machine for choreographic session type protocols
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

//! Identity model for topology and capability assignment.

use std::collections::{BTreeMap, BTreeSet};

use serde::{Deserialize, Serialize};

/// Participant identifier.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub struct ParticipantId(pub String);

impl From<&str> for ParticipantId {
    fn from(value: &str) -> Self {
        Self(value.to_string())
    }
}

/// Site identifier.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub struct SiteId(pub String);

impl From<&str> for SiteId {
    fn from(value: &str) -> Self {
        Self(value.to_string())
    }
}

/// Identity model for topology and capabilities.
pub trait IdentityModel {
    /// Participant type.
    type ParticipantId: Clone + Ord;
    /// Site type.
    type SiteId: Clone + Ord;

    /// Enumerate known sites.
    fn sites(&self) -> Vec<Self::SiteId>;
    /// Resolve a stable site display name.
    fn site_name(&self, site: &Self::SiteId) -> String;
    /// Capabilities provided by one site.
    fn site_capabilities(&self, site: &Self::SiteId) -> BTreeSet<String>;
    /// Set of reliable directed links.
    fn reliable_edges(&self) -> BTreeSet<(Self::SiteId, Self::SiteId)>;
}

/// Simple static identity topology model.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StaticIdentityModel {
    /// Site metadata keyed by identifier.
    pub sites: BTreeMap<SiteId, SiteInfo>,
    /// Reliable directed links.
    pub reliable_edges: BTreeSet<(SiteId, SiteId)>,
}

/// Site metadata.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SiteInfo {
    /// Display name for the site.
    pub name: String,
    /// Site capability labels.
    pub capabilities: BTreeSet<String>,
}

impl IdentityModel for StaticIdentityModel {
    type ParticipantId = ParticipantId;
    type SiteId = SiteId;

    fn sites(&self) -> Vec<Self::SiteId> {
        self.sites.keys().cloned().collect()
    }

    fn site_name(&self, site: &Self::SiteId) -> String {
        self.sites
            .get(site)
            .map(|info| info.name.clone())
            .unwrap_or_else(|| site.0.clone())
    }

    fn site_capabilities(&self, site: &Self::SiteId) -> BTreeSet<String> {
        self.sites
            .get(site)
            .map(|info| info.capabilities.clone())
            .unwrap_or_default()
    }

    fn reliable_edges(&self) -> BTreeSet<(Self::SiteId, Self::SiteId)> {
        self.reliable_edges.clone()
    }
}