Skip to content

Commit 6c0ec6a

Browse files
committed
TLS docs for tokio-postgres
1 parent 49c22a8 commit 6c0ec6a

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

postgres/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
//!
5151
//! TLS support is implemented via external libraries. `Client::connect` and `Config::connect` take a TLS implementation
5252
//! as an argument. The `NoTls` type in this crate can be used when TLS is not required. Otherwise, the
53-
//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `postgres` and
53+
//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `openssl` and
5454
//! `native-tls` crates, respectively.
5555
#![warn(clippy::all, rust_2018_idioms, missing_docs)]
5656

tokio-postgres/src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,13 @@
101101
//! The client works with arbitrary `AsyncRead + AsyncWrite` streams. Convenience APIs are provided to handle the
102102
//! connection process, but these are gated by the `runtime` Cargo feature, which is enabled by default. If disabled,
103103
//! all dependence on the tokio runtime is removed.
104+
//!
105+
//! # SSL/TLS support
106+
//!
107+
//! TLS support is implemented via external libraries. `Client::connect` and `Config::connect` take a TLS implementation
108+
//! as an argument. The `NoTls` type in this crate can be used when TLS is not required. Otherwise, the
109+
//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `openssl` and
110+
//! `native-tls` crates, respectively.
104111
#![doc(html_root_url = "https://docs.rs/tokio-postgres/0.4.0-rc.1")]
105112
#![warn(rust_2018_idioms, clippy::all, missing_docs)]
106113

0 commit comments

Comments
 (0)