network-tables 0.1.3

A implementation of WPI's Network Tables spec
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

use std::{borrow::Cow, collections::HashSet};

use serde::{Deserialize, Serialize};

use super::{subscription::SubscriptionOptions, topic::PublishProperties, Type};

#[derive(Debug, Serialize, Deserialize)]
#[serde(tag = "method", content = "params", rename_all = "lowercase")]
pub(crate) enum NTMessage<'a> {
    #[serde(borrow = "'a")]
    Publish(PublishTopic<'a>),
    Unpublish(UnpublishTopic),
    Subscribe(Subscribe),
    Unsubscribe(Unsubscribe),
    SetProperties(SetProperties<'a>),
    #[serde(borrow = "'a")]
    Announce(Announce<'a>),
    #[serde(borrow = "'a")]
    UnAnnounce(UnAnnounce<'a>),
    #[serde(borrow = "'a")]
    Properties(Properties<'a>),
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct PublishTopic<'a> {
    pub(crate) name: &'a str,
    pub(crate) pubuid: u32,
    pub(crate) r#type: Type,
    /// Initial topic properties.
    /// If the topic is newly created (e.g. there are no other publishers) this sets the topic properties.
    /// If the topic was previously published, this is ignored. The announce message contains the actual topic properties.
    /// Clients can use the setproperties message to change properties after topic creation.
    #[serde(borrow = "'a", skip_serializing_if = "Option::is_none")]
    pub(crate) properties: Cow<'a, Option<PublishProperties>>,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct UnpublishTopic {
    pub(crate) pubuid: u32,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct Subscribe {
    pub(crate) subuid: i32,
    pub(crate) topics: HashSet<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(crate) options: Option<SubscriptionOptions>,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct Unsubscribe {
    pub(crate) subuid: i32,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct SetProperties<'a> {
    pub(crate) name: &'a str,
    pub(crate) update: Cow<'a, PublishProperties>,
}

/// The server shall send this message for each of the following conditions:
/// - To all clients subscribed to a matching prefix when a topic is created
/// - To a client in response to an Publish Request Message (publish) from that client
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct Announce<'a> {
    /// Topic name
    pub(crate) name: &'a str,
    /// Topic id
    pub(crate) id: i32,
    /// Topic type
    pub(crate) r#type: Type,
    /// If this message was sent in response to a publish message,
    /// the Publisher UID provided in that message. Otherwise absent.
    pub(crate) pubuid: Option<i32>,
    /// Topic properties
    pub(crate) properties: PublishProperties,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct UnAnnounce<'a> {
    /// Topic name
    pub(crate) name: &'a str,
    /// Topic id
    pub(crate) id: i32,
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub struct Properties<'a> {
    /// Topic name
    pub(crate) name: &'a str,
    /// Acknowledgement - True if this message is in response to a setproperties message from the same client.
    /// Otherwise absent.
    pub(crate) ack: Option<bool>,
}