objtalk 0.3.0

a lightweight realtime database for IoT projects
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

use crate::{Object, Command};
use serde::{Serialize,Deserialize};
use serde_json::Value;
use uuid::Uuid;

// { id, type: "get", name, value }
// { type: "response", requestId, result, error }

#[derive(Deserialize, Debug)]
#[serde(tag = "type")]
#[serde(rename_all = "lowercase")]
pub enum Request {
	Set {
		name: String,
		value: Value,
	},
	Patch {
		name: String,
		value: Value,
	},
	Get {
		pattern: String,
	},
	#[serde(rename_all = "camelCase")]
	Query {
		pattern: String,
		#[serde(default = "bool::default")]
		provide_rpc: bool,
	},
	#[serde(rename_all = "camelCase")]
	Unsubscribe {
		query_id: Uuid,
	},
	Remove {
		name: String,
	},
	Emit {
		object: String,
		event: String,
		data: Value,
	},
	Invoke {
		object: String,
		method: String,
		args: Value,
	},
	#[serde(rename = "invokeResult")]
	#[serde(rename_all = "camelCase")]
	InvokeResult {
		invocation_id: Uuid,
		result: Value,
	},
	#[serde(rename = "setDisconnectCommands")]
	SetDisconnectCommands {
		commands: Vec<Command>,
	},
}

#[derive(Serialize, Debug)]
#[serde(untagged)]
pub enum Response {
	Success {
		success: bool,
	},
	Get {
		objects: Vec<Object>,
	},
	#[serde(rename_all = "camelCase")]
	Query {
		query_id: Uuid,
		objects: Vec<Object>,
	},
	Remove {
		existed: bool,
	}
}

#[derive(Deserialize, Debug)]
pub struct RequestMessage {
	pub id: Value,
	#[serde(flatten)]
	pub request: Request,
}

#[derive(Serialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct ResponseMessage {
	pub request_id: Value,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub result: Option<Response>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub error: Option<String>,
}

#[derive(Serialize, Debug)]
#[serde(tag = "type")]
#[serde(rename_all = "camelCase")]
pub enum EventMessage {
	#[serde(rename_all = "camelCase")]
	QueryAdd {
		query_id: Uuid,
		object: Object,
	},
	#[serde(rename_all = "camelCase")]
	QueryChange {
		query_id: Uuid,
		object: Object,
	},
	#[serde(rename_all = "camelCase")]
	QueryRemove {
		query_id: Uuid,
		object: Object,
	},
	#[serde(rename_all = "camelCase")]
	QueryEvent {
		query_id: Uuid,
		object: String,
		event: String,
		data: Value,
	},
	#[serde(rename_all = "camelCase")]
	QueryInvocation {
		invocation_id: Uuid,
		query_id: Uuid,
		object: String,
		method: String,
		args: Value,
	},
	// TODO: not an event message?
	#[serde(rename_all = "camelCase")]
	InvocationResult {
		request_id: Value,
		#[serde(skip_serializing_if = "Option::is_none")]
		result: Option<Value>,
		#[serde(skip_serializing_if = "Option::is_none")]
		error: Option<String>,
	}
}