From 6c0ec6a6bf2092cd1962fd8a5e069de31112f5a4 Mon Sep 17 00:00:00 2001 From: Steven Fackler Date: Mon, 1 Apr 2019 21:56:25 -0700 Subject: [PATCH] TLS docs for tokio-postgres --- postgres/src/lib.rs | 2 +- tokio-postgres/src/lib.rs | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/postgres/src/lib.rs b/postgres/src/lib.rs index 41d85ad5..f643db6e 100644 --- a/postgres/src/lib.rs +++ b/postgres/src/lib.rs @@ -50,7 +50,7 @@ //! //! TLS support is implemented via external libraries. `Client::connect` and `Config::connect` take a TLS implementation //! as an argument. The `NoTls` type in this crate can be used when TLS is not required. Otherwise, the -//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `postgres` and +//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `openssl` and //! `native-tls` crates, respectively. #![warn(clippy::all, rust_2018_idioms, missing_docs)] diff --git a/tokio-postgres/src/lib.rs b/tokio-postgres/src/lib.rs index bb1304c5..060e0c5d 100644 --- a/tokio-postgres/src/lib.rs +++ b/tokio-postgres/src/lib.rs @@ -101,6 +101,13 @@ //! The client works with arbitrary `AsyncRead + AsyncWrite` streams. Convenience APIs are provided to handle the //! connection process, but these are gated by the `runtime` Cargo feature, which is enabled by default. If disabled, //! all dependence on the tokio runtime is removed. +//! +//! # SSL/TLS support +//! +//! TLS support is implemented via external libraries. `Client::connect` and `Config::connect` take a TLS implementation +//! as an argument. The `NoTls` type in this crate can be used when TLS is not required. Otherwise, the +//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `openssl` and +//! `native-tls` crates, respectively. #![doc(html_root_url = "https://docs.rs/tokio-postgres/0.4.0-rc.1")] #![warn(rust_2018_idioms, clippy::all, missing_docs)]