Return any impl of Message in recv_message, fixes #112

websockets-rs · Apr 10, 2017 · 0dc2417 · 0dc2417
1 parent bf05966
commit 0dc2417
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/src/client/mod.rs b/src/client/mod.rs
@@ -162,9 +162,22 @@ impl<S> Client<S>
 	}
 
 	/// Reads a single message from this receiver.
-	pub fn recv_message<'m, M, I>(&mut self) -> WebSocketResult<M>
-		where M: ws::Message<'m, DataFrame, DataFrameIterator = I>,
-		      I: Iterator<Item = DataFrame>
+	///
+	/// ```rust,no_run
+	/// use websocket::{ClientBuilder, Message};
+	/// let mut client = ClientBuilder::new("ws://localhost:3000")
+	///     .unwrap()
+	///     .connect_insecure()
+	///     .unwrap();
+	///
+	/// client.send_message(&Message::text("Hello world!")).unwrap();
+	///
+	/// let message: Message = client.recv_message().unwrap();
+	/// ```
+	pub fn recv_message<'m, M, I, D>(&mut self) -> WebSocketResult<M>
+		where M: ws::Message<'m, D, DataFrameIterator = I>,
+		      I: Iterator<Item = D>,
+		      D: DataFrameable
 	{
 		self.receiver.recv_message(&mut self.stream)
 	}

diff --git a/src/receiver.rs b/src/receiver.rs
@@ -39,9 +39,10 @@ impl<R> Reader<R>
 	}
 
 	/// Reads a single message from this receiver.
-	pub fn recv_message<'m, M, I>(&mut self) -> WebSocketResult<M>
-		where M: ws::Message<'m, DataFrame, DataFrameIterator = I>,
-		      I: Iterator<Item = DataFrame>
+	pub fn recv_message<'m, M, D, I>(&mut self) -> WebSocketResult<M>
+		where M: ws::Message<'m, D, DataFrameIterator = I>,
+		      I: Iterator<Item = D>,
+		      D: DataFrameable
 	{
 		self.receiver.recv_message(&mut self.stream)
 	}