rucent 0.1.4

Centrifugo HTTP API client
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::fmt;

/// Error reptrests API request error.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Error {
    pub code: u32,
    pub message: String,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}: {}", self.message, self.code)
    }
}

impl std::error::Error for Error {}

/// Reply is for server response to command
#[derive(Serialize, Deserialize, Debug)]
pub struct Reply {
    pub error: Option<Error>,
    pub result: Option<serde_json::Value>,
}

/// ClientInfo represents information about one client connection to centrifugo.
/// This struct used in messages published by clients, join/leave events, presence data
#[derive(Serialize, Deserialize, Debug)]
pub struct ClientInfo {
    pub user: String,
    pub client: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub conn_info: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub chan_info: Option<serde_json::Value>,
}

/// Publication represents message published into channel.
#[derive(Serialize, Deserialize, Debug)]
pub struct Publication {
    pub offset: u64,
    pub data: serde_json::Value,
    pub info: Option<ClientInfo>,
}

/// NodeInfo contains information and statistics about Centrifugo node.
#[derive(Serialize, Deserialize, Debug)]
pub struct NodeInfo {
    /// uid is a unique id of running node.
    pub uid: String,
    /// name is a name of node (config defined or generated automatically).
    pub name: String,
    /// version of Centrifugo node.
    pub version: String,
    /// num_clients is a number of clients connected to node.
    pub num_clients: u32,
    /// num_users is a number of unique users connected to node
    pub num_users: u32,
    /// num_channels is a number of channels on node
    pub num_channels: u32,
    /// uptime of node in seconds.
    pub uptime: u32,
}

/// Info Result is a reulst of info command
#[derive(Serialize, Deserialize, Debug)]
pub struct InfoResult {
    pub nodes: Vec<NodeInfo>,
}

/// PublishResult is a result of publish command
#[derive(Serialize, Deserialize, Debug)]
pub struct PublishResult {
    pub offset: Option<u64>,
    pub epoch: Option<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PublishResponse {
    pub error: Option<Error>,
    pub result: PublishResult,
}

/// BroadcastResult is a result of broadcast command
#[derive(Serialize, Deserialize, Debug)]
pub struct BroadcastResult {
    pub responses: Vec<PublishResponse>,
}

/// PresenceStatsResult is a result of presence command
#[derive(Serialize, Deserialize, Debug)]
pub struct PresenceResult {
    pub presence: HashMap<String, ClientInfo>,
}

/// PresenceStatsResult is a reuslt of info command
#[derive(Serialize, Deserialize, Debug)]
pub struct PresenceStatsResult {
    pub num_users: u32,
    pub num_clients: u32,
}

/// HistoryResult is a result of history command
#[derive(Serialize, Deserialize, Debug)]
pub struct HistoryResult {
    pub publication: Vec<Publication>,
    pub offset: u64,
    pub epoch: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ChannelInfo {
    pub num_clients: u32,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ChannelsResult {
    pub channels: HashMap<String, ChannelInfo>,
}