dcs2 0.1.0

An extensible distributed control system framework made in rust with no-std support.
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

use alloc::format;
use alloc::string::ToString;
use core::fmt::{Debug, Display, Formatter};
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};

use crate::communication::connection::Address;
use crate::config::SystemNodeArgs;
use crate::nodes::SystemMetadata;

/// A [`BasicMetadata`] that can be serialized and deserialized
pub trait SerializableMetadata: BasicMetadata + Serialize + DeserializeOwned {}

/// Metadata associated to a cluster node.
pub trait BasicMetadata: Clone + Debug + Display {}

#[derive(Default, Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct NoCoordinatedMetadata;

impl Display for NoCoordinatedMetadata {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> core::fmt::Result {
        write!(formatter, "[Empty]")
    }
}

impl BasicMetadata for NoCoordinatedMetadata {}

impl SerializableMetadata for NoCoordinatedMetadata {}

/// Metadata at the transport layer level. I.e. bluetooth or tcp/ip.  
pub trait CommunicationMetadata: BasicMetadata {
    type Addr: Address;
    fn address(&self) -> Self::Addr;
}

#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
pub struct NodeMetadata<CoordMetadata: BasicMetadata, CommMetadata: CommunicationMetadata> {
    pub node: SystemMetadata<CommMetadata>,
    pub coordination: Option<CoordMetadata>,
}

impl<CoordMetadata: BasicMetadata, CommMetadata: CommunicationMetadata> BasicMetadata
    for NodeMetadata<CoordMetadata, CommMetadata>
{
}

impl<CoordMetadata: BasicMetadata, CommMetadata: CommunicationMetadata> Display
    for NodeMetadata<CoordMetadata, CommMetadata>
{
    fn fmt(&self, formatter: &mut Formatter<'_>) -> core::fmt::Result {
        let coordination = self
            .coordination
            .clone()
            .map(|coord| format!("{}", coord))
            .unwrap_or_else(|| "None".to_string());

        write!(
            formatter,
            "(Role: {:?}, Coordination: {}, Communication: {})",
            self.node.role, coordination, self.node.communication
        )
    }
}

pub trait CoordinationMetadataBuilder<Metadata: SerializableMetadata + BasicMetadata>:
    Default
{
    fn build(args: &SystemNodeArgs) -> Metadata;
}

pub trait CommunicationMetadataBuilder<Metadata: CommunicationMetadata>: Default {
    fn build(args: &SystemNodeArgs) -> Metadata;
}