xmppftw/xmpp-rs
Watch
1
0
Fork
You've already forked xmpp-rs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

sasl: make docs.rs emit nice feature tags on feature-gated items

Browse source
This commit is contained in:
Jonas Schäfer 2024-04-20 09:13:03 +02:00
commit 13be111de1
9 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
sasl/src/server/mechanisms/mod.rs
View file

@ -5,7 +5,9 @@ mod plain;
mod scram;
#[cfg(feature = "anonymous")]
#[cfg_attr(docsrs, doc(cfg(feature = "anonymous")))]
pub use self::anonymous::Anonymous;
pub use self::plain::Plain;
#[cfg(feature = "scram")]
#[cfg_attr(docsrs, doc(cfg(feature = "scram")))]
pub use self::scram::Scram;

6
sasl/src/server/mod.rs
View file

@ -36,6 +36,7 @@ pub trait Validator<S: Secret> {
pub enum ProviderError {
AuthenticationFailed,
#[cfg(feature = "scram")]
#[cfg_attr(docsrs, doc(cfg(feature = "scram")))]
DeriveError(DeriveError),
}
@ -65,8 +66,10 @@ pub enum MechanismError {
CannotDecodeResponse,
#[cfg(feature = "scram")]
#[cfg_attr(docsrs, doc(cfg(feature = "scram")))]
InvalidKeyLength(hmac::digest::InvalidLength),
#[cfg(any(feature = "scram", feature = "anonymous"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "scram", feature = "anonymous"))))]
RandomFailure(getrandom::Error),
NoProof,
CannotDecodeProof,
@ -75,6 +78,7 @@ pub enum MechanismError {
}
#[cfg(feature = "scram")]
#[cfg_attr(docsrs, doc(cfg(feature = "scram")))]
impl From<DeriveError> for ProviderError {
fn from(err: DeriveError) -> ProviderError {
ProviderError::DeriveError(err)
@ -100,6 +104,7 @@ impl From<ValidatorError> for MechanismError {
}
#[cfg(feature = "scram")]
#[cfg_attr(docsrs, doc(cfg(feature = "scram")))]
impl From<hmac::digest::InvalidLength> for MechanismError {
fn from(err: hmac::digest::InvalidLength) -> MechanismError {
MechanismError::InvalidKeyLength(err)
@ -107,6 +112,7 @@ impl From<hmac::digest::InvalidLength> for MechanismError {
}
#[cfg(any(feature = "scram", feature = "anonymous"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "scram", feature = "anonymous"))))]
impl From<getrandom::Error> for MechanismError {
fn from(err: getrandom::Error) -> MechanismError {
MechanismError::RandomFailure(err)