Added documentation and force_https function. #19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
April 17, 2018 20:08
Added documentation that explains hyper_tls's default behaviour when a URL using the HTTP scheme is used. Also added a force_https function that will force the use of TLS when connecting to a URL.
ghost
mentioned this pull request
Closed
seanmonstar
reviewed
Apr 17, 2018
src/client.rs
Outdated
| let is_https = dst.scheme() == "https"; | ||
| // Early abort if TLS is forced but can't be used | ||
| if !is_https && self.force_https { | ||
| let err = io::Error::new(io::ErrorKind::Other, "TLS forced but TLS can't be used"); |
There was a problem hiding this comment.
I'd probably phrase this HTTPS scheme required or similar.
src/client.rs
Outdated
| /// This uses hyper's default `HttpConnector`, and default `TlsConnector`. | ||
| /// If you wish to use something besides the defaults, use `From::from`. | ||
| /// | ||
| /// # Warning |
There was a problem hiding this comment.
I'd change this to "Note" instead of "Warning".
There was a problem hiding this comment.
I originally had it as Note, i'll change it back.
|
Thank you! |
ghost
deleted the
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added documentation that explains hyper_tls's default behaviour when a
URL using the HTTP scheme is used. Also added a force_https function
that will force the use of TLS when connecting to a URL.