Skip to content

Commit bb40fb5

Browse files
authored
Doc required features to enable tls and sasl types (#70)
See also: * rust-lang/rust#43781 * https://docs.rs/about/builds
1 parent c2ce0d8 commit bb40fb5

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ test:
1818
cargo test --all-features
1919

2020
doc:
21-
cargo doc --all-features
21+
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc --all-features

src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
//! * `smol`: Toggle support for [smol](https://docs.rs/smol) builtin global executor.
2828
//! * `async-global-executor`: Toggle support for [async-global-executor](https://docs.rs/async-global-executor).
2929
30+
#![cfg_attr(docsrs, feature(doc_cfg))]
31+
3032
mod acl;
3133
mod chroot;
3234
mod client;
@@ -45,11 +47,15 @@ mod util;
4547
pub use self::acl::{Acl, Acls, AuthId, AuthUser, Permission};
4648
pub use self::error::Error;
4749
#[cfg(feature = "tls")]
50+
#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
4851
pub use self::tls::{TlsCa, TlsCerts, TlsCertsBuilder, TlsCertsOptions, TlsDynamicCerts, TlsIdentity, TlsOptions};
4952
pub use crate::client::*;
5053
#[cfg(feature = "sasl-digest-md5")]
54+
#[cfg_attr(docsrs, doc(cfg(any(feature = "sasl", feature = "sasl-digest-md5"))))]
5155
pub use crate::sasl::DigestMd5SaslOptions;
5256
#[cfg(feature = "sasl-gssapi")]
57+
#[cfg_attr(docsrs, doc(cfg(any(feature = "sasl", feature = "sasl-gssapi"))))]
5358
pub use crate::sasl::GssapiSaslOptions;
5459
#[cfg(any(feature = "sasl-digest-md5", feature = "sasl-gssapi"))]
60+
#[cfg_attr(docsrs, doc(cfg(any(feature = "sasl", feature = "sasl-gssapi", feature = "sasl-digest-md5"))))]
5561
pub use crate::sasl::SaslOptions;

src/sasl/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,14 @@ impl SaslOptions {
4545
/// provides no mean to grant ticket from KDC but simply utilizes whatever the ticket cache
4646
/// have.
4747
#[cfg(feature = "sasl-gssapi")]
48+
#[cfg_attr(docsrs, doc(cfg(any(feature = "sasl", feature = "sasl-gssapi"))))]
4849
pub fn gssapi() -> GssapiSaslOptions {
4950
GssapiSaslOptions::new()
5051
}
5152

5253
/// Construct a [DigestMd5SaslOptions] for further customization.
5354
#[cfg(feature = "sasl-digest-md5")]
55+
#[cfg_attr(docsrs, doc(cfg(any(feature = "sasl", feature = "sasl-digest-md5"))))]
5456
pub fn digest_md5(
5557
username: impl Into<Cow<'static, str>>,
5658
password: impl Into<Cow<'static, str>>,

0 commit comments

Comments
 (0)