Rename ErrorString to ErrorMessage

Author: phil-opp

Changelog.md

@@ -20,7 +20,7 @@
 - Move crate to 2018 edition
 - Refactor and cleanup the code
 - Remove the dependency on `failure`
-    - Use a custom `ErrorString` type instead
+    - Use a custom `ErrorMessage` type instead
 - Add a new `run-args` config key
 - Add a new `--quiet` argument to suppress output
 

src/args.rs

@@ -1,8 +1,8 @@
-use crate::{config::Config, Command, ErrorString};
+use crate::{config::Config, Command, ErrorMessage};
 use std::path::{Path, PathBuf};
 use std::{env, mem};
 
-pub(crate) fn parse_args() -> Result<Command, ErrorString> {
+pub(crate) fn parse_args() -> Result<Command, ErrorMessage> {
     let mut args = env::args();
     let executable_name = args.next().ok_or("no first argument (executable name)")?;
     let first = args.next();
@@ -36,7 +36,7 @@ pub(crate) fn parse_args() -> Result<Command, ErrorString> {
     }
 }
 
-fn parse_build_args<A>(args: A) -> Result<Command, ErrorString>
+fn parse_build_args<A>(args: A) -> Result<Command, ErrorMessage>
 where
     A: Iterator<Item = String>,
 {
@@ -49,7 +49,7 @@ where
     let mut run_args_started = false;
     let mut quiet = false;
     {
-        fn set<T>(arg: &mut Option<T>, value: Option<T>) -> Result<(), ErrorString> {
+        fn set<T>(arg: &mut Option<T>, value: Option<T>) -> Result<(), ErrorMessage> {
             let previous = mem::replace(arg, value);
             if previous.is_some() {
                 Err("multiple arguments of same type provided")?
@@ -209,7 +209,7 @@ impl Args {
     }
 }
 
-fn parse_runner_args<A>(args: A) -> Result<Command, ErrorString>
+fn parse_runner_args<A>(args: A) -> Result<Command, ErrorMessage>
 where
     A: Iterator<Item = String>,
 {
@@ -257,4 +257,3 @@ pub struct RunnerArgs {
     /// Suppress any output to stdout.
     pub quiet: bool,
 }
-

src/config.rs

@@ -1,4 +1,4 @@
-use crate::ErrorString;
+use crate::ErrorMessage;
 use std::path::PathBuf;
 use toml::Value;
 
@@ -11,13 +11,13 @@ pub struct Config {
     pub test_timeout: u32,
 }
 
-pub(crate) fn read_config(manifest_path: PathBuf) -> Result<Config, ErrorString> {
+pub(crate) fn read_config(manifest_path: PathBuf) -> Result<Config, ErrorMessage> {
     let config = read_config_inner(manifest_path)
         .map_err(|err| format!("Failed to read bootimage configuration: {:?}", err))?;
     Ok(config)
 }
 
-pub(crate) fn read_config_inner(manifest_path: PathBuf) -> Result<Config, ErrorString> {
+pub(crate) fn read_config_inner(manifest_path: PathBuf) -> Result<Config, ErrorMessage> {
     use std::{fs::File, io::Read};
     let cargo_toml: Value = {
         let mut content = String::new();

src/lib.rs

@@ -36,7 +36,7 @@ pub fn lib_main() {
     }
 }
 
-pub fn run() -> Result<Option<i32>, ErrorString> {
+pub fn run() -> Result<Option<i32>, ErrorMessage> {
     let command = args::parse_args()?;
     let none = |()| None;
     match command {
@@ -54,22 +54,22 @@ pub fn run() -> Result<Option<i32>, ErrorString> {
     }
 }
 
-pub struct ErrorString {
+pub struct ErrorMessage {
     pub message: Box<dyn fmt::Display + Send>,
 }
 
-impl fmt::Debug for ErrorString {
+impl fmt::Debug for ErrorMessage {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         self.message.fmt(f)
     }
 }
 
-impl<T> From<T> for ErrorString
+impl<T> From<T> for ErrorMessage
 where
     T: fmt::Display + Send + 'static,
 {
     fn from(err: T) -> Self {
-        ErrorString {
+        ErrorMessage {
             message: Box::new(err),
         }
     }

src/subcommand/build.rs

@@ -1,7 +1,7 @@
-use crate::{args::Args, builder::Builder, config, ErrorString};
+use crate::{args::Args, builder::Builder, config, ErrorMessage};
 use std::{path::PathBuf, process};
 
-pub(crate) fn build(mut args: Args) -> Result<(), ErrorString> {
+pub(crate) fn build(mut args: Args) -> Result<(), ErrorMessage> {
     let builder = Builder::new(args.manifest_path().clone())?;
     let config = config::read_config(builder.kernel_manifest_path().to_owned())?;
     args.apply_default_target(&config, builder.kernel_root());
@@ -14,7 +14,7 @@ pub(crate) fn build_impl(
     builder: &Builder,
     args: &Args,
     quiet: bool,
-) -> Result<Vec<PathBuf>, ErrorString> {
+) -> Result<Vec<PathBuf>, ErrorMessage> {
     run_cargo_fetch(&args);
 
     let executables = builder.build_kernel(&args.cargo_args, quiet)?;

src/subcommand/run.rs

@@ -1,7 +1,7 @@
-use crate::{args::Args, builder::Builder, config, ErrorString};
+use crate::{args::Args, builder::Builder, config, ErrorMessage};
 use std::process;
 
-pub(crate) fn run(mut args: Args) -> Result<i32, ErrorString> {
+pub(crate) fn run(mut args: Args) -> Result<i32, ErrorMessage> {
     use crate::subcommand::build;
 
     let builder = Builder::new(args.manifest_path().clone())?;
@@ -23,7 +23,7 @@ pub(crate) fn run(mut args: Args) -> Result<i32, ErrorString> {
                 "{}",
                 bootimage_path
                     .to_str()
-                    .ok_or(ErrorString::from("bootimage path is not valid unicode"))?,
+                    .ok_or(ErrorMessage::from("bootimage path is not valid unicode"))?,
             ),
         );
     }
@@ -32,7 +32,7 @@ pub(crate) fn run(mut args: Args) -> Result<i32, ErrorString> {
     }
     command.args(&args.run_args);
     let exit_status = command.status().map_err(|err| {
-        ErrorString::from(format!(
+        ErrorMessage::from(format!(
             "Failed to execute run command `{:?}`: {}",
             command, err
         ))

src/subcommand/runner.rs

@@ -1,7 +1,7 @@
-use crate::{args::RunnerArgs, builder::Builder, config, ErrorString};
+use crate::{args::RunnerArgs, builder::Builder, config, ErrorMessage};
 use std::process;
 
-pub(crate) fn runner(args: RunnerArgs) -> Result<i32, ErrorString> {
+pub(crate) fn runner(args: RunnerArgs) -> Result<i32, ErrorMessage> {
     let builder = Builder::new(None)?;
     let config = config::read_config(builder.kernel_manifest_path().to_owned())?;
 

src/subcommand/test.rs

@@ -1,9 +1,9 @@
-use crate::{args::Args, builder::Builder, config, subcommand::build, ErrorString};
+use crate::{args::Args, builder::Builder, config, subcommand::build, ErrorMessage};
 use rayon::prelude::*;
 use std::{fs, io, io::Write, process, time::Duration};
 use wait_timeout::ChildExt;
 
-pub(crate) fn test(mut args: Args) -> Result<(), ErrorString> {
+pub(crate) fn test(mut args: Args) -> Result<(), ErrorMessage> {
     let builder = Builder::new(args.manifest_path().clone())?;
     let config = config::read_config(builder.kernel_manifest_path().to_owned())?;
     args.apply_default_target(&config, builder.kernel_root());
@@ -83,7 +83,7 @@ pub(crate) fn test(mut args: Args) -> Result<(), ErrorString> {
 
             Ok((target.name.clone(), test_result))
         })
-        .collect::<Result<Vec<(String, TestResult)>, ErrorString>>()?;
+        .collect::<Result<Vec<(String, TestResult)>, ErrorMessage>>()?;
 
     println!("");
     if tests.iter().all(|t| t.1 == TestResult::Ok) {
@@ -102,7 +102,7 @@ fn handle_exit_status(
     exit_status: process::ExitStatus,
     output: &str,
     target_name: &str,
-) -> Result<TestResult, ErrorString> {
+) -> Result<TestResult, ErrorMessage> {
     match exit_status.code() {
         None => {
             writeln!(io::stderr(), "FAIL: No Exit Code.")?;