tokio-xmpp: Document TlsStream type behind 'ktls' feature

pep created 3 months ago

Signed-off-by: pep <pep@bouah.net>

Change summary

tokio-xmpp/ChangeLog                 | 1 +
tokio-xmpp/src/connect/tls_common.rs | 1 +
2 files changed, 2 insertions(+)

Detailed changes

tokio-xmpp/ChangeLog 🔗

@@ -41,6 +41,7 @@ XXXX-YY-ZZ RELEASER <admin@example.com>
       - `rustls` is now re-exported if it is enabled, to allow applications to
         set the default crypto provider if needed. (!581)
       - Derive Debug on Client and associated structs
+      - Document TlsStream behind 'ktls' feature
     * Changes:
       - On Linux, once the TLS session is established, we can delegate the
         actual encryption and decryption to the kernel, which in turn can

tokio-xmpp/src/connect/tls_common.rs 🔗

@@ -36,6 +36,7 @@ use {
 pub use tokio_rustls::client::TlsStream;
 
 #[cfg(all(feature = "ktls", not(feature = "native-tls")))]
+/// Tls Stream type based on Ktls
 pub type TlsStream<S> = ktls::KtlsStream<S>;
 
 #[cfg(feature = "native-tls")]