From c2ac875c36b96adf92c4c2c58afa5b185f075e6c Mon Sep 17 00:00:00 2001 From: Ryan <49769153+TurnOfACard@users.noreply.github.com> Date: Wed, 1 Mar 2023 22:40:11 +1100 Subject: [PATCH] Clarify the documentation to show that get will fail if the total download time is exceeded (#1762) Co-authored-by: Ryan --- src/blocking/mod.rs | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/blocking/mod.rs b/src/blocking/mod.rs index 7db601d02..487387545 100644 --- a/src/blocking/mod.rs +++ b/src/blocking/mod.rs @@ -98,11 +98,12 @@ pub use self::response::Response; /// /// This function fails if: /// -/// - native TLS backend cannot be initialized -/// - supplied `Url` cannot be parsed -/// - there was an error while sending request -/// - redirect loop was detected -/// - redirect limit was exhausted +/// - the native TLS backend cannot be initialized, +/// - the supplied `Url` cannot be parsed, +/// - there was an error while sending request, +/// - a redirect loop was detected, +/// - the redirect limit was exhausted, or +/// - the total download time exceeds 30 seconds. pub fn get(url: T) -> crate::Result { Client::builder().build()?.get(url).send() }