Examples for Error

[AndyGauge]

Closes #117

[AndyGauge]

In the Issue, @dtolnay asks for examples with depth. Requesting review of example before completing the remaining methods to ensure quality.

[seanmonstar]

Thanks for doing this documentation work! I left some comments about how to prevent network operations while running doc tests, and some thoughts on what sort of examples would be typical.

[seanmonstar]

Thanks for doing this documentation work! I left some comments about how to prevent network operations while running doc tests, and some thoughts on what sort of examples would be typical.

[seanmonstar]

It'd be better if the doctests didn't actually make a network request. This can just be # fn main() {}.

[seanmonstar]

The extern crate and main aren't necessary. This can be:

/// # fn run() {
/// let response = ...
/// # }

[seanmonstar]

This error probably won't have a URL associated with it, since it wasn't able to parse one. The url() method will have a Url if reqwest was able to parse the error and start an HTTP request. Situations this would have a Url and be useful for:

• The redirect policy notices a loop. You can check the url() for the last request made that determined there was a loop.
• There was a network error while making the request. Again, also useful if after a redirect, the server aborted the socket early, while still emitting headers. You could see the io::Error occurred from which server.

[AndyGauge]

Difficult to translate into an example. I created a hyper server to give me a redirect loop. I'll post the client example to show the final stop. Unfortunately it wont be reproducible without a redirect loop server (of which I could not find an online example of a redirect loop)

[seanmonstar]

I'd guess that @dtolnay meant to show a typical example of why someone would actually use this method. You can already print the reqwest::Error, so why would a user want to call get_ref?

A possible reason could be to try to handle certain cases, like casting to a UrlError and inspecting exactly what was wrong with the provide URL.

[seanmonstar]

Thanks!