taptap 0.1.1

An implementation of the Tigo TAP protocol
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use crate::pv::application::NodeTableResponseEntry;
use crate::pv::network::NodeAddress;
use crate::pv::{LongAddress, NodeID};
use schemars::{JsonSchema, Schema, SchemaGenerator};
use serde::de::Error;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::borrow::Cow;
use std::collections::BTreeMap;

#[derive(Debug, Clone, Eq, PartialEq, Default)]
pub struct NodeTable(pub(crate) BTreeMap<NodeID, LongAddress>);

impl JsonSchema for NodeTable {
    fn schema_name() -> Cow<'static, str> {
        "NodeTable".into()
    }

    fn schema_id() -> Cow<'static, str> {
        concat!(module_path!(), "::NodeTable").into()
    }

    fn json_schema(gen: &mut SchemaGenerator) -> Schema {
        schemars::json_schema!({
            "type": "array",
            "uniqueItems": true,
            "items": gen.subschema_for::<NodeTableEntry>(),
        })
    }
}

#[derive(Debug, Clone, Eq, PartialEq, JsonSchema, Serialize, Deserialize)]
struct NodeTableEntry {
    pub node_id: NodeID,
    pub long_address: LongAddress,
}

impl From<(NodeID, LongAddress)> for NodeTableEntry {
    fn from((node_id, long_address): (NodeID, LongAddress)) -> Self {
        Self {
            node_id,
            long_address,
        }
    }
}
impl From<(&NodeID, &LongAddress)> for NodeTableEntry {
    fn from((&node_id, &long_address): (&NodeID, &LongAddress)) -> Self {
        Self {
            node_id,
            long_address,
        }
    }
}
impl From<NodeTableEntry> for (NodeID, LongAddress) {
    fn from(value: NodeTableEntry) -> Self {
        (value.node_id, value.long_address)
    }
}

// Serialize as Vec<Entry>
impl Serialize for NodeTable {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let entries: Vec<NodeTableEntry> = self.0.iter().map(NodeTableEntry::from).collect();
        entries.serialize(serializer)
    }
}

// Deserialize from Vec<Entry>
impl<'de> Deserialize<'de> for NodeTable {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let entries = <Vec<NodeTableEntry>>::deserialize(deserializer)?;
        let len = entries.len();
        let output: Self = Self(
            entries
                .into_iter()
                .map(<(NodeID, LongAddress)>::from)
                .collect(),
        );

        if output.0.len() == len {
            Ok(output)
        } else {
            Err(D::Error::custom(
                "node_ids must be unique within a node table",
            ))
        }
    }
}

#[derive(Debug, Clone, Eq, PartialEq, Default)]
pub struct NodeTableBuilder {
    expected_next: Option<NodeID>,
    table: NodeTable,
}

impl NodeTableBuilder {
    pub fn push(
        &mut self,
        start_address: NodeAddress,
        entries: &[NodeTableResponseEntry],
    ) -> Option<NodeTable> {
        // Are we continuing an existing table?
        if NodeAddress::from(self.expected_next) != start_address {
            // Reset
            self.expected_next = Default::default();
            self.table = Default::default();
            if start_address == NodeAddress::ZERO {
                // We're mid-table
                // Ignore
                return None;
            }
        }

        // Insert all the records
        for entry in entries {
            let Ok(node_id) = entry.node_id.try_into() else {
                // Fail
                self.expected_next = None;
                return None;
            };

            // Insert the record
            self.table.0.insert(node_id, entry.long_address);
        }

        // This was the end of the table?
        if entries.is_empty() {
            // Take the table
            let mut table = Default::default();
            std::mem::swap(&mut self.table, &mut table);

            // Reset
            self.expected_next = None;

            // Return the table
            Some(table)
        } else {
            // There's more
            let last = self.table.0.last_entry().unwrap();
            self.expected_next = last.key().successor();

            // Did we wrap?
            if self.expected_next.is_none() {
                self.table = Default::default();
            }

            None
        }
    }
}