boardwalk 1.0.0

Hypermedia server framework with reverse-tunnel federation
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

use serde::{Deserialize, Serialize};

use super::envelope::{EventId, NodeId, StreamId};

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum InboundMessage {
    #[serde(rename = "subscribe")]
    Subscribe {
        topic: String,
        #[serde(default)]
        limit: Option<u64>,
        #[serde(default, rename = "outboundCapacity")]
        outbound_capacity: Option<usize>,
    },
    #[serde(rename = "unsubscribe")]
    Unsubscribe {
        #[serde(rename = "subscriptionId")]
        subscription_id: u64,
    },
    #[serde(rename = "ping")]
    Ping {
        #[serde(default)]
        data: Option<String>,
    },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
#[allow(clippy::large_enum_variant)] // Event carries the optional envelope mirror; boxing would obscure the wire shape.
pub enum OutboundMessage {
    #[serde(rename = "subscribe-ack")]
    SubscribeAck {
        timestamp: i64,
        topic: String,
        #[serde(rename = "subscriptionId")]
        subscription_id: u64,
    },
    #[serde(rename = "unsubscribe-ack")]
    UnsubscribeAck {
        timestamp: i64,
        #[serde(rename = "subscriptionId")]
        subscription_id: u64,
    },
    #[serde(rename = "event")]
    Event {
        topic: String,
        #[serde(rename = "subscriptionId")]
        subscription_id: SubscriptionRef,
        timestamp: i64,
        data: serde_json::Value,
        #[serde(rename = "eventId", skip_serializing_if = "Option::is_none")]
        event_id: Option<EventId>,
        #[serde(rename = "streamId", skip_serializing_if = "Option::is_none")]
        stream_id: Option<StreamId>,
        #[serde(skip_serializing_if = "Option::is_none")]
        stream: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        sequence: Option<u64>,
        #[serde(rename = "nodeId", skip_serializing_if = "Option::is_none")]
        node_id: Option<NodeId>,
        #[serde(rename = "resourceId", skip_serializing_if = "Option::is_none")]
        resource_id: Option<String>,
        #[serde(rename = "resourceKind", skip_serializing_if = "Option::is_none")]
        resource_kind: Option<String>,
        #[serde(rename = "payloadKind", skip_serializing_if = "Option::is_none")]
        payload_kind: Option<String>,
        #[serde(rename = "payloadVersion", skip_serializing_if = "Option::is_none")]
        payload_version: Option<u32>,
        #[serde(rename = "envelopeVersion", skip_serializing_if = "Option::is_none")]
        envelope_version: Option<u8>,
        #[serde(rename = "isoTimestamp", skip_serializing_if = "Option::is_none")]
        iso_timestamp: Option<String>,
    },
    #[serde(rename = "pong")]
    Pong {
        timestamp: i64,
        #[serde(default)]
        data: Option<String>,
    },
    #[serde(rename = "error")]
    Error {
        code: u16,
        timestamp: i64,
        topic: Option<String>,
        message: Option<String>,
        #[serde(rename = "subscriptionId", skip_serializing_if = "Option::is_none")]
        subscription_id: Option<u64>,
    },
    #[serde(rename = "stream-gap")]
    StreamGap {
        timestamp: i64,
        #[serde(rename = "subscriptionId")]
        subscription_id: u64,
        #[serde(rename = "streamId", skip_serializing_if = "Option::is_none")]
        stream_id: Option<StreamId>,
        #[serde(
            rename = "lastDeliveredSequence",
            skip_serializing_if = "Option::is_none"
        )]
        last_delivered_sequence: Option<u64>,
        reason: String,
        terminated: bool,
    },
}

/// Either a single id or an array (when `?filterMultiple=true`).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum SubscriptionRef {
    Single(u64),
    Multiple(Vec<u64>),
}