dwn-core 0.4.0

Core DWN types.
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

use std::collections::HashMap;

use semver::Version;
use serde::{Deserialize, Serialize};
use serde_with::{DisplayFromStr, serde_as, skip_serializing_none};

use crate::message::{
    Message,
    cid::CidGenerationError,
    descriptor::{Descriptor, Interface, Method},
};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct ProtocolsConfigure {
    interface: Interface,
    method: Method,
    pub protocol_version: semver::Version,
    pub definition: ProtocolDefinition,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct ProtocolDefinition {
    pub protocol: String,
    pub published: bool,
    pub types: HashMap<String, ProtocolType>,
    pub structure: HashMap<String, ProtocolStructure>,
}

#[serde_as]
#[skip_serializing_none]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct ProtocolType {
    #[serde_as(as = "Vec<DisplayFromStr>")]
    pub data_format: Vec<mime::Mime>,
    pub schema: Option<String>,
}

#[skip_serializing_none]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct ProtocolStructure {
    #[serde(rename = "$actions")]
    pub actions: Option<Vec<ProtocolRule>>,
    #[serde(flatten)]
    pub children: HashMap<String, ProtocolStructure>,
}

#[skip_serializing_none]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct ProtocolRule {
    pub who: Who,
    pub can: Vec<Can>,
    pub of: Option<String>,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub enum Who {
    Anyone,
    Author,
    Recipient,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub enum Can {
    Create,
    Delete,
    Query,
    Read,
    Subscribe,
    Update,
}

pub struct ProtocolsConfigureBuilder {
    version: Version,
    definition: ProtocolDefinition,
}

impl ProtocolsConfigureBuilder {
    pub fn new(version: Version, definition: ProtocolDefinition) -> Self {
        Self {
            version,
            definition,
        }
    }

    pub fn build(self) -> Result<Message, CidGenerationError> {
        let descriptor = Descriptor::ProtocolsConfigure(Box::new(ProtocolsConfigure {
            interface: Interface::Protocols,
            method: Method::Configure,
            protocol_version: self.version,
            definition: self.definition,
        }));

        Ok(Message {
            record_id: descriptor.compute_entry_id()?,
            context_id: None,
            data: None,
            descriptor,
            attestation: None,
            authorization: None,
        })
    }
}