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/starttls.rs
+++ b/tokio-xmpp/src/starttls.rs
@ -11,6 +11,8 @@ use crate::{Error, ProtocolError};
 /// XMPP TLS XML namespace
 pub const NS_XMPP_TLS: &str = "urn:ietf:params:xml:ns:xmpp-tls";

+/// Performs `<starttls/>` on an XMPPStream and returns a binary
+/// TlsStream.
 pub async fn starttls<S: AsyncRead + AsyncWrite + Unpin>(
    mut xmpp_stream: XMPPStream<S>,
 ) -> Result<TlsStream<S>, Error> {