rs_jsonrpc_pubsub/
types.rs

1use std::sync::Arc;
2use core;
3use core::futures::sync::mpsc;
4
5use subscription::Session;
6
7/// Raw transport sink for specific client.
8pub type TransportSender = mpsc::Sender<String>;
9/// Raw transport error.
10pub type TransportError = mpsc::SendError<String>;
11/// Subscription send result.
12pub type SinkResult = core::futures::sink::Send<TransportSender>;
13
14/// Metadata extension for pub-sub method handling.
15pub trait PubSubMetadata: core::Metadata {
16	/// Returns session object associated with given request/client.
17	/// `None` indicates that sessions are not supported on the used transport.
18	fn session(&self) -> Option<Arc<Session>>;
19}
20
21/// Unique subscription id.
22/// NOTE Assigning same id to different requests will cause the previous request to be unsubscribed.
23#[derive(Debug, Clone, PartialEq, Eq, Hash)]
24pub enum SubscriptionId {
25	/// U64 number
26	Number(u64),
27	/// String
28	String(String),
29}
30
31impl SubscriptionId {
32	/// Parses `core::Value` into unique subscription id.
33	pub fn parse_value(val: &core::Value) -> Option<SubscriptionId> {
34		match *val {
35			core::Value::String(ref val) => Some(SubscriptionId::String(val.clone())),
36			core::Value::Number(ref val) => val.as_u64().map(SubscriptionId::Number),
37			_ => None,
38		}
39	}
40}
41
42impl From<String> for SubscriptionId {
43	fn from(other: String) -> Self {
44		SubscriptionId::String(other)
45	}
46}
47
48impl From<u64> for SubscriptionId {
49	fn from(other: u64) -> Self {
50		SubscriptionId::Number(other)
51	}
52}
53
54impl From<SubscriptionId> for core::Value {
55	fn from(sub: SubscriptionId) -> Self {
56		match sub {
57			SubscriptionId::Number(val) => core::Value::Number(val.into()),
58			SubscriptionId::String(val) => core::Value::String(val),
59		}
60	}
61}
62
63#[cfg(test)]
64mod tests {
65	use core::Value;
66	use super::SubscriptionId;
67
68	#[test]
69	fn should_convert_between_value_and_subscription_id() {
70		// given
71		let val1 = Value::Number(5.into());
72		let val2 = Value::String("asdf".into());
73		let val3 = Value::Null;
74
75		// when
76		let res1 = SubscriptionId::parse_value(&val1);
77		let res2 = SubscriptionId::parse_value(&val2);
78		let res3 = SubscriptionId::parse_value(&val3);
79
80		// then
81		assert_eq!(res1, Some(SubscriptionId::Number(5)));
82		assert_eq!(res2, Some(SubscriptionId::String("asdf".into())));
83		assert_eq!(res3, None);
84
85		// and back
86		assert_eq!(Value::from(res1.unwrap()), val1);
87		assert_eq!(Value::from(res2.unwrap()), val2);
88	}
89}
rs_jsonrpc_pubsub/types.rs

rs_jsonrpc_pubsub/
types.rs
