Skip to content

Commit 96b611a

Browse files
committed
docs: add construction links for builder types
1 parent b71aa2c commit 96b611a

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

Makefile

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
check: check_fmt lint
1+
check: check_fmt lint doc
22

33
verify: check build test
44

@@ -16,3 +16,6 @@ build:
1616

1717
test:
1818
cargo test --all-features
19+
20+
doc:
21+
cargo doc --all-features

src/client/mod.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -1536,7 +1536,9 @@ impl Drop for OwnedLockClient {
15361536
#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)]
15371537
pub(crate) struct Version(u32, u32, u32);
15381538

1539-
/// A builder for [Client].
1539+
/// A builder for [Client] with more options than [Client::connect].
1540+
///
1541+
/// Uses [Client::connector] to construct one.
15401542
#[derive(Clone, Debug)]
15411543
pub struct Connector {
15421544
#[cfg(feature = "tls")]
@@ -1553,7 +1555,6 @@ pub struct Connector {
15531555
connection_timeout: Duration,
15541556
}
15551557

1556-
/// Builder for [Client] with more options than [Client::connect].
15571558
impl Connector {
15581559
fn new() -> Self {
15591560
Self {

src/sasl/digest_md5.rs

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ use rsasl::property::{AuthId, Password, Realm};
77
use super::{Result, SaslInitiator, SaslInnerOptions, SaslOptions, SaslSession};
88

99
/// DIGEST-MD5 SASL options.
10+
///
11+
/// Uses [SaslOptions::digest_md5] to construct one.
1012
#[derive(Clone, Debug)]
1113
pub struct DigestMd5SaslOptions {
1214
realm: Option<Cow<'static, str>>,

src/sasl/gssapi.rs

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ impl From<GssapiSaslOptions> for SaslOptions {
1414
}
1515

1616
/// GSSAPI SASL options.
17+
///
18+
/// Uses [SaslOptions::gssapi] to construct one.
1719
#[derive(Clone, Debug)]
1820
pub struct GssapiSaslOptions {
1921
username: Cow<'static, str>,

0 commit comments

Comments
 (0)