bitconch_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
21impl PubSubMetadata for Arc<Session> {
22	fn session(&self) -> Option<Arc<Session>> {
23		Some(self.clone())
24	}
25}
26
27impl<T: PubSubMetadata> PubSubMetadata for Option<T> {
28	fn session(&self) -> Option<Arc<Session>> {
29		self.as_ref().and_then(|s| s.session())
30	}
31}
32
33/// Unique subscription id.
34/// NOTE Assigning same id to different requests will cause the previous request to be unsubscribed.
35#[derive(Debug, Clone, PartialEq, Eq, Hash)]
36pub enum SubscriptionId {
37	/// U64 number
38	Number(u64),
39	/// String
40	String(String),
41}
42
43impl SubscriptionId {
44	/// Parses `core::Value` into unique subscription id.
45	pub fn parse_value(val: &core::Value) -> Option<SubscriptionId> {
46		match *val {
47			core::Value::String(ref val) => Some(SubscriptionId::String(val.clone())),
48			core::Value::Number(ref val) => val.as_u64().map(SubscriptionId::Number),
49			_ => None,
50		}
51	}
52}
53
54impl From<String> for SubscriptionId {
55	fn from(other: String) -> Self {
56		SubscriptionId::String(other)
57	}
58}
59
60impl From<u64> for SubscriptionId {
61	fn from(other: u64) -> Self {
62		SubscriptionId::Number(other)
63	}
64}
65
66impl From<SubscriptionId> for core::Value {
67	fn from(sub: SubscriptionId) -> Self {
68		match sub {
69			SubscriptionId::Number(val) => core::Value::Number(val.into()),
70			SubscriptionId::String(val) => core::Value::String(val),
71		}
72	}
73}
74
75#[cfg(test)]
76mod tests {
77	use core::Value;
78	use super::SubscriptionId;
79
80	#[test]
81	fn should_convert_between_value_and_subscription_id() {
82		// given
83		let val1 = Value::Number(5.into());
84		let val2 = Value::String("asdf".into());
85		let val3 = Value::Null;
86
87		// when
88		let res1 = SubscriptionId::parse_value(&val1);
89		let res2 = SubscriptionId::parse_value(&val2);
90		let res3 = SubscriptionId::parse_value(&val3);
91
92		// then
93		assert_eq!(res1, Some(SubscriptionId::Number(5)));
94		assert_eq!(res2, Some(SubscriptionId::String("asdf".into())));
95		assert_eq!(res3, None);
96
97		// and back
98		assert_eq!(Value::from(res1.unwrap()), val1);
99		assert_eq!(Value::from(res2.unwrap()), val2);
100	}
101}
bitconch_jsonrpc_pubsub/types.rs

bitconch_jsonrpc_pubsub/
types.rs
