tokio-xmpp: doc

2020-03-16 00:34:46 +01:00 · 2020-03-16 00:34:46 +01:00 · a4325c787a
commit a4325c787a
parent b6828b9674
5 changed files with 40 additions and 8 deletions
--- a/tokio-xmpp/src/stream_start.rs
+++ b/tokio-xmpp/src/stream_start.rs
@ -10,6 +10,8 @@ use crate::{Error, ProtocolError};

 const NS_XMPP_STREAM: &str = "http://etherx.jabber.org/streams";

+/// Sends a `<stream:stream>`, then wait for one from the server, and
+/// construct an XMPPStream.
 pub async fn start<S: AsyncRead + AsyncWrite + Unpin>(
    mut stream: Framed<S, XMPPCodec>,
    jid: Jid,