diff options
| author | Joachim Viide <jviide@iki.fi> | 2016-06-07 02:37:12 +0300 |
|---|---|---|
| committer | Joachim Viide <jviide@iki.fi> | 2016-06-07 02:48:20 +0300 |
| commit | 75fc40c668ca564b08674caebc32c77325900689 (patch) | |
| tree | c1e2074995bd785bcd652bb7a15a648a579e4b69 | |
| parent | 763f9234b052c7911dc4cf952a81a85c51c57784 (diff) | |
| download | rust-75fc40c668ca564b08674caebc32c77325900689.tar.gz rust-75fc40c668ca564b08674caebc32c77325900689.zip | |
Remove a gotcha from book/error-handling.md
The book's "Error handling with Box<Error>" section talks about Box<Error>. In the actual example Box<Error + Send + Sync> is used instead so that the corresponding From impls could be used to convert a plain string to an error type. Rust 1.7 added support for conversion from &str/String to Box<Error>, so this gotcha and later references to it can now be removed.
| -rw-r--r-- | src/doc/book/error-handling.md | 20 |
1 files changed, 8 insertions, 12 deletions
diff --git a/src/doc/book/error-handling.md b/src/doc/book/error-handling.md index d94eeaebf40..544f837d69b 100644 --- a/src/doc/book/error-handling.md +++ b/src/doc/book/error-handling.md @@ -1829,7 +1829,7 @@ use std::error::Error; fn search<P: AsRef<Path>> (file_path: P, city: &str) - -> Result<Vec<PopulationCount>, Box<Error+Send+Sync>> { + -> Result<Vec<PopulationCount>, Box<Error>> { let mut found = vec![]; let file = try!(File::open(file_path)); let mut rdr = csv::Reader::from_reader(file); @@ -1858,20 +1858,17 @@ Instead of `x.unwrap()`, we now have `try!(x)`. Since our function returns a `Result<T, E>`, the `try!` macro will return early from the function if an error occurs. -There is one big gotcha in this code: we used `Box<Error + Send + Sync>` -instead of `Box<Error>`. We did this so we could convert a plain string to an -error type. We need these extra bounds so that we can use the -[corresponding `From` -impls](../std/convert/trait.From.html): +At the end of `search` we also convert a plain string to an error type +by using the [corresponding `From` impls](../std/convert/trait.From.html): ```rust,ignore // We are making use of this impl in the code above, since we call `From::from` // on a `&'static str`. -impl<'a, 'b> From<&'b str> for Box<Error + Send + Sync + 'a> +impl<'a> From<&'a str> for Box<Error> // But this is also useful when you need to allocate a new string for an // error message, usually with `format!`. -impl From<String> for Box<Error + Send + Sync> +impl From<String> for Box<Error> ``` Since `search` now returns a `Result<T, E>`, `main` should use case analysis @@ -1964,7 +1961,7 @@ use std::io; fn search<P: AsRef<Path>> (file_path: &Option<P>, city: &str) - -> Result<Vec<PopulationCount>, Box<Error+Send+Sync>> { + -> Result<Vec<PopulationCount>, Box<Error>> { let mut found = vec![]; let input: Box<io::Read> = match *file_path { None => Box::new(io::stdin()), @@ -2175,9 +2172,8 @@ heuristics! `unwrap`. Be warned: if it winds up in someone else's hands, don't be surprised if they are agitated by poor error messages! * If you're writing a quick 'n' dirty program and feel ashamed about panicking - anyway, then use either a `String` or a `Box<Error + Send + Sync>` for your - error type (the `Box<Error + Send + Sync>` type is because of the - [available `From` impls](../std/convert/trait.From.html)). + anyway, then use either a `String` or a `Box<Error>` for your + error type. * Otherwise, in a program, define your own error types with appropriate [`From`](../std/convert/trait.From.html) and |
