websocket 0.12.2

A WebSocket (RFC6455) library for Rust.
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

//! Provides a trait for receiving data frames and messages.
//!
//! Also provides iterators over data frames and messages.
//! See the `ws` module documentation for more information.

use std::marker::PhantomData;
use ws::Message;
use result::WebSocketResult;

/// A trait for receiving data frames and messages.
pub trait Receiver<D>: Sized {
	/// Reads a single data frame from this receiver.
	fn recv_dataframe(&mut self) -> WebSocketResult<D>;
	/// Returns the data frames that constitute one message.
	fn recv_message_dataframes(&mut self) -> WebSocketResult<Vec<D>>;
	
	/// Returns an iterator over incoming data frames.
	fn incoming_dataframes<'a>(&'a mut self) -> DataFrameIterator<'a, Self, D> {
		DataFrameIterator {
			inner: self,
			_dataframe: PhantomData
		}
	}
	/// Reads a single message from this receiver.
	fn recv_message<M, I>(&mut self) -> WebSocketResult<M>
		where M: Message<D, DataFrameIterator = I>, I: Iterator<Item = D> {
		
		let dataframes = try!(self.recv_message_dataframes());
		Message::from_dataframes(dataframes)
	}
	
	/// Returns an iterator over incoming messages.
	fn incoming_messages<'a, M>(&'a mut self) -> MessageIterator<'a, Self, D, M>
		where M: Message<D> {
		
		MessageIterator {
			inner: self,
			_dataframe: PhantomData,
			_message: PhantomData
		}
	}
}

/// An iterator over data frames from a Receiver.
pub struct DataFrameIterator<'a, R, D>
	where R: 'a + Receiver<D> {
	
	inner: &'a mut R,
	_dataframe: PhantomData<D>
}

impl<'a, R, D> Iterator for DataFrameIterator<'a, R, D>
	where R: 'a + Receiver<D> {

	type Item = WebSocketResult<D>;
	
	/// Get the next data frame from the receiver. Always returns `Some`.
	fn next(&mut self) -> Option<WebSocketResult<D>> {
		Some(self.inner.recv_dataframe())
	}
}

/// An iterator over messages from a Receiver.
pub struct MessageIterator<'a, R, D, M> 
	where R: 'a + Receiver<D>, M: Message<D> {

	inner: &'a mut R,
	_dataframe: PhantomData<D>,
	_message: PhantomData<M>
}

impl<'a, R, D, M, I> Iterator for MessageIterator<'a, R, D, M>
	where R: 'a + Receiver<D>, M: Message<D, DataFrameIterator = I>, I: Iterator<Item = D> {
	
	type Item = WebSocketResult<M>;
	
	/// Get the next message from the receiver. Always returns `Some`.
	fn next(&mut self) -> Option<WebSocketResult<M>> {
		Some(self.inner.recv_message())
	}
}