pep/xmpp-rs-mirror
1
0
Fork 0
mirror of https://gitlab.com/xmpp-rs/xmpp-rs.git synced 2024-07-12 22:21:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add some documentation to src/sasl/mod.rs

Browse source
This commit is contained in:
lumi 2017-02-25 15:50:26 +01:00
parent a88d9aa566
commit 4f357f773b
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/sasl/mod.rs
View file

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