From 9a66c5748b972ee46004963e7c365c73408140bb Mon Sep 17 00:00:00 2001 From: Sean McArthur Date: Thu, 27 Feb 2020 12:47:38 -0800 Subject: [PATCH] Document advanced (brittle) nature of use_preconfigured_tls --- src/async_impl/client.rs | 9 +++++++++ src/blocking/client.rs | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/src/async_impl/client.rs b/src/async_impl/client.rs index 9383565..152046f 100644 --- a/src/async_impl/client.rs +++ b/src/async_impl/client.rs @@ -750,6 +750,15 @@ impl ClientBuilder { /// If the passed `Any` argument is not a TLS backend that reqwest /// understands, the `ClientBuilder` will error when calling `build`. /// + /// # Advanced + /// + /// This is an advanced option, and can be somewhat brittle. Usage requires + /// keeping the preconfigured TLS argument version in sync with reqwest, + /// since version mismatches will result in an "unknown" TLS backend. + /// + /// If possible, it's preferable to use the methods on `ClientBuilder` + /// to configure reqwest's TLS. + /// /// # Optional /// /// This requires one of the optional features `native-tls` or diff --git a/src/blocking/client.rs b/src/blocking/client.rs index 9e276c3..6a82f36 100644 --- a/src/blocking/client.rs +++ b/src/blocking/client.rs @@ -460,6 +460,15 @@ impl ClientBuilder { /// If the passed `Any` argument is not a TLS backend that reqwest /// understands, the `ClientBuilder` will error when calling `build`. /// + /// # Advanced + /// + /// This is an advanced option, and can be somewhat brittle. Usage requires + /// keeping the preconfigured TLS argument version in sync with reqwest, + /// since version mismatches will result in an "unknown" TLS backend. + /// + /// If possible, it's preferable to use the methods on `ClientBuilder` + /// to configure reqwest's TLS. + /// /// # Optional /// /// This requires one of the optional features `native-tls` or