Improve Interoperability with Error Reporting Tools

Cargo.toml

@@ -28,6 +28,7 @@ serde = "1.0.55"
 
 [dev-dependencies]
 bstr = { version = "1.7.0", default-features = false, features = ["alloc", "serde"] }
+eyre = "~0.6.12"
 serde = { version = "1.0.55", features = ["derive"] }
 
 [profile.release]

examples/tutorial-error-05.rs

@@ -0,0 +1,18 @@
+use eyre::Result;
+use std::{io, process};
+
+fn main() {
+    if let Err(err) = run() {
+        println!("{:?}", err);
+        process::exit(1);
+    }
+}
+
+fn run() -> Result<()> {
+    let mut rdr = csv::Reader::from_reader(io::stdin());
+    for result in rdr.records() {
+        let record = result?;
+        println!("{:?}", record);
+    }
+    Ok(())
+}

examples/tutorial-perf-alloc-01.rs

@@ -1,6 +1,7 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
-fn run() -> Result<u64, Box<dyn Error>> {
+fn run() -> Result<u64> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
 
     let mut count = 0;
@@ -19,7 +20,7 @@ fn main() {
             println!("{}", count);
         }
         Err(err) => {
-            println!("{}", err);
+            println!("{:?}", err);
             process::exit(1);
         }
     }

examples/tutorial-perf-alloc-02.rs

@@ -1,6 +1,7 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
-fn run() -> Result<u64, Box<dyn Error>> {
+fn run() -> Result<u64> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
 
     let mut count = 0;
@@ -19,7 +20,7 @@ fn main() {
             println!("{}", count);
         }
         Err(err) => {
-            println!("{}", err);
+            println!("{:?}", err);
             process::exit(1);
         }
     }

examples/tutorial-perf-alloc-03.rs

@@ -1,6 +1,7 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
-fn run() -> Result<u64, Box<dyn Error>> {
+fn run() -> Result<u64> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
     let mut record = csv::ByteRecord::new();
 
@@ -19,7 +20,7 @@ fn main() {
             println!("{}", count);
         }
         Err(err) => {
-            println!("{}", err);
+            println!("{:?}", err);
             process::exit(1);
         }
     }

examples/tutorial-perf-core-01.rs

@@ -1,3 +1,4 @@
+use eyre::Report;
 use std::io::{self, Read};
 use std::process;
 
@@ -63,7 +64,7 @@ fn main() {
     // Read the entire contents of stdin up front.
     let mut data = vec![];
     if let Err(err) = io::stdin().read_to_end(&mut data) {
-        println!("{}", err);
+        println!("{:?}", Report::from(err));
         process::exit(1);
     }
     match run(&data) {

examples/tutorial-perf-serde-01.rs

@@ -1,5 +1,6 @@
 #![allow(dead_code)]
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
 use serde::Deserialize;
 
@@ -15,7 +16,7 @@ struct Record {
     longitude: f64,
 }
 
-fn run() -> Result<u64, Box<dyn Error>> {
+fn run() -> Result<u64> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
 
     let mut count = 0;
@@ -34,7 +35,7 @@ fn main() {
             println!("{}", count);
         }
         Err(err) => {
-            println!("{}", err);
+            println!("{:?}", err);
             process::exit(1);
         }
     }

examples/tutorial-perf-serde-02.rs

@@ -1,6 +1,7 @@
 #![allow(dead_code)]
+use eyre::Result;
 use serde::Deserialize;
-use std::{error::Error, io, process};
+use std::{io, process};
 
 #[derive(Debug, Deserialize)]
 #[serde(rename_all = "PascalCase")]
@@ -14,7 +15,7 @@ struct Record<'a> {
     longitude: f64,
 }
 
-fn run() -> Result<u64, Box<dyn Error>> {
+fn run() -> Result<u64> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
     let mut raw_record = csv::StringRecord::new();
     let headers = rdr.headers()?.clone();
@@ -35,7 +36,7 @@ fn main() {
             println!("{}", count);
         }
         Err(err) => {
-            println!("{}", err);
+            println!("{:?}", err);
             process::exit(1);
         }
     }

examples/tutorial-perf-serde-03.rs

@@ -1,5 +1,6 @@
 #![allow(dead_code)]
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
 use serde::Deserialize;
 
@@ -15,7 +16,7 @@ struct Record<'a> {
     longitude: f64,
 }
 
-fn run() -> Result<u64, Box<dyn Error>> {
+fn run() -> Result<u64> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
     let mut raw_record = csv::ByteRecord::new();
     let headers = rdr.byte_headers()?.clone();
@@ -36,7 +37,7 @@ fn main() {
             println!("{}", count);
         }
         Err(err) => {
-            println!("{}", err);
+            println!("{:?}", err);
             process::exit(1);
         }
     }

examples/tutorial-pipeline-pop-01.rs

@@ -1,4 +1,5 @@
-use std::{env, error::Error, io, process};
+use eyre::{eyre, Result};
+use std::{env, io, process};
 
 use serde::{Deserialize, Serialize};
 
@@ -14,11 +15,11 @@ struct Record {
     longitude: f64,
 }
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     // Get the query from the positional arguments.
     // If one doesn't exist or isn't an integer, return an error.
     let minimum_pop: u64 = match env::args().nth(1) {
-        None => return Err(From::from("expected 1 argument, but got none")),
+        None => return Err(eyre!("expected 1 argument, but got none")),
         Some(arg) => arg.parse()?,
     };
 
@@ -53,7 +54,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-pipeline-search-01.rs

@@ -1,10 +1,11 @@
-use std::{env, error::Error, io, process};
+use eyre::{eyre, Result};
+use std::{env, io, process};
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     // Get the query from the positional arguments.
     // If one doesn't exist, return an error.
     let query = match env::args().nth(1) {
-        None => return Err(From::from("expected 1 argument, but got none")),
+        None => return Err(eyre!("expected 1 argument, but got none")),
         Some(query) => query,
     };
 
@@ -31,7 +32,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-pipeline-search-02.rs

@@ -1,8 +1,9 @@
-use std::{env, error::Error, io, process};
+use eyre::{eyre, Result};
+use std::{env, io, process};
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     let query = match env::args().nth(1) {
-        None => return Err(From::from("expected 1 argument, but got none")),
+        None => return Err(eyre!("expected 1 argument, but got none")),
         Some(query) => query,
     };
 
@@ -26,7 +27,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-read-01.rs

@@ -1,6 +1,7 @@
-use std::{env, error::Error, ffi::OsString, fs::File, process};
+use eyre::{eyre, Result};
+use std::{env, ffi::OsString, fs::File, process};
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     let file_path = get_first_arg()?;
     let file = File::open(file_path)?;
     let mut rdr = csv::Reader::from_reader(file);
@@ -13,16 +14,16 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 /// Returns the first positional argument sent to this process. If there are no
 /// positional arguments, then this returns an error.
-fn get_first_arg() -> Result<OsString, Box<dyn Error>> {
+fn get_first_arg() -> Result<OsString> {
     match env::args_os().nth(1) {
-        None => Err(From::from("expected 1 argument, but got none")),
+        None => Err(eyre!("expected 1 argument, but got none")),
         Some(file_path) => Ok(file_path),
     }
 }
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-read-delimiter-01.rs

@@ -1,6 +1,7 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     let mut rdr = csv::ReaderBuilder::new()
         .has_headers(false)
         .delimiter(b';')
@@ -18,7 +19,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-read-headers-01.rs

@@ -1,6 +1,7 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     let mut rdr =
         csv::ReaderBuilder::new().has_headers(false).from_reader(io::stdin());
     for result in rdr.records() {
@@ -12,7 +13,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-read-headers-02.rs

@@ -1,6 +1,7 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
     {
         // We nest this call in its own scope because of lifetimes.
@@ -20,7 +21,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-read-serde-01.rs

@@ -1,6 +1,7 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
     for result in rdr.records() {
         let record = result?;
@@ -27,7 +28,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }

examples/tutorial-read-serde-02.rs

@@ -1,10 +1,11 @@
-use std::{error::Error, io, process};
+use eyre::Result;
+use std::{io, process};
 
 // This introduces a type alias so that we can conveniently reference our
 // record type.
 type Record = (String, String, Option<u64>, f64, f64);
 
-fn run() -> Result<(), Box<dyn Error>> {
+fn run() -> Result<()> {
     let mut rdr = csv::Reader::from_reader(io::stdin());
     // Instead of creating an iterator with the `records` method, we create
     // an iterator with the `deserialize` method.
@@ -18,7 +19,7 @@ fn run() -> Result<(), Box<dyn Error>> {
 
 fn main() {
     if let Err(err) = run() {
-        println!("{}", err);
+        println!("{:?}", err);
         process::exit(1);
     }
 }