chorus_lib 0.5.0

Choreographic Programming in Rust
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

//! Built-in transports.

pub mod http;
pub mod local;

use crate::core::{ChoreographyLocation, HCons, LocationSet};
use std::collections::HashMap;
use std::marker::PhantomData;

/// A generic struct for configuration of `Transport`.
#[derive(Clone)]
pub struct TransportConfig<'a, Target: ChoreographyLocation, TargetInfo, L: LocationSet, Info> {
    /// The information about locations
    pub info: HashMap<&'static str, Info>,
    /// The information about the target choreography
    pub target_info: (Target, TargetInfo),
    /// The struct is parametrized by the location set (`L`).
    location_set: PhantomData<L>,
    lifetime: PhantomData<&'a ()>,
}

/// A builder for `TransportConfig`.
///
/// Use this builder to create a `TransportConfig` instance.
///
/// # Examples
///
/// ```
/// use chorus_lib::core::{LocationSet, ChoreographyLocation};
/// use chorus_lib::transport::TransportConfigBuilder;
///
/// #[derive(ChoreographyLocation)]
/// struct Alice;
///
/// #[derive(ChoreographyLocation)]
/// struct Bob;
///
/// let transport_config = TransportConfigBuilder::for_target(Alice, "value_for_target".to_string())
///    .with(Bob, "value_for_bob".to_string())
///    .build();
/// ```
pub struct TransportConfigBuilder<
    'a,
    Target: ChoreographyLocation,
    TargetInfo,
    L: LocationSet,
    Info,
> {
    target: (Target, TargetInfo),
    location_set: PhantomData<L>,
    info: HashMap<&'static str, Info>,
    lifetime: PhantomData<&'a ()>,
}

impl<'a, Target: ChoreographyLocation, TargetInfo, Info>
    TransportConfigBuilder<'a, Target, TargetInfo, LocationSet!(Target), Info>
{
    /// Creates a new `TransportConfigBuilder` instance for a given target.
    pub fn for_target(target: Target, info: TargetInfo) -> Self {
        Self {
            target: (target, info),
            location_set: PhantomData,
            info: HashMap::new(),
            lifetime: PhantomData,
        }
    }
}

impl<'a, Target: ChoreographyLocation, TargetInfo, L: LocationSet, Info>
    TransportConfigBuilder<'a, Target, TargetInfo, L, Info>
{
    /// Adds information about a new `ChoreographyLocation`.
    ///
    /// This method tells the builder that the choreography involves a new location and how to communicate with it.
    pub fn with<'b, NewLocation: ChoreographyLocation>(
        self,
        location: NewLocation,
        info: Info,
    ) -> TransportConfigBuilder<'b, Target, TargetInfo, HCons<NewLocation, L>, Info> {
        _ = location;
        let mut new_info = self.info;
        new_info.insert(NewLocation::name(), info);
        TransportConfigBuilder {
            target: self.target,
            location_set: PhantomData,
            info: new_info,
            lifetime: PhantomData,
        }
    }

    /// Builds a `TransportConfig` instance.
    pub fn build<'b>(self) -> TransportConfig<'b, Target, TargetInfo, L, Info> {
        TransportConfig {
            info: self.info,
            target_info: self.target,
            location_set: PhantomData,
            lifetime: PhantomData,
        }
    }
}