Skip to content

Commit e0b1eee

Browse files
committed
Doc tweaks
1 parent 1627d62 commit e0b1eee

3 files changed

Lines changed: 4 additions & 6 deletions

File tree

src/io/mod.rs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,6 @@ pub trait StreamWrapper: fmt::Debug + Read + Write + Send {
2323
}
2424

2525
/// A trait implemented by types that can negotiate SSL over a Postgres stream.
26-
///
27-
/// If the `with-openssl` Cargo feature is enabled, this trait will be
28-
/// implemented for `openssl::ssl::SslContext`.
29-
///
30-
/// If the `security-framework` Cargo feature is enabled, this trait will be
31-
/// implemented for `security_framework::secure_transport::ClientBuilder`.
3226
pub trait NegotiateSsl: fmt::Debug {
3327
/// Negotiates an SSL session, returning a wrapper around the provided
3428
/// stream.

src/io/openssl.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ impl StreamWrapper for SslStream<Stream> {
2121
}
2222

2323
/// A `NegotiateSsl` implementation that uses OpenSSL.
24+
///
25+
/// Requires the `with-openssl` feature.
2426
#[derive(Debug)]
2527
pub struct Negotiator(SslContext);
2628

src/io/security_framework.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ impl StreamWrapper for SslStream<Stream> {
1616
}
1717

1818
/// A `NegotiateSsl` implementation that uses Security Framework.
19+
///
20+
/// Requires the `security-framework` feature.
1921
#[derive(Debug)]
2022
pub struct Negotiator(ClientBuilder);
2123

0 commit comments

Comments
 (0)