add some documentation to src/sasl/mod.rs

lumi created 9 years ago

Change summary

src/sasl/mod.rs | 4 ++++
1 file changed, 4 insertions(+)

Detailed changes

src/sasl/mod.rs

@@ -1,13 +1,17 @@
 //! Provides the `SaslMechanism` trait and some implementations.
 
+/// A struct containing SASL credentials.
 pub struct SaslCredentials {
     pub username: String,
     pub secret: SaslSecret,
     pub channel_binding: Option<Vec<u8>>,
 }
 
+/// Represents a SASL secret, like a password.
 pub enum SaslSecret {
+    /// No extra data needed.
     None,
+    /// Password required.
     Password(String),
 }