magg 0.4.3

Sophisticated tooling for Rust developers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! # Definition of result and errors

use std::path::Path;
use std::process::ExitStatus;

/// Common result type.
pub type Result<T, E = MaggError> = std::result::Result<T, E>;

/// Error definition.
#[derive(Debug, PartialEq, Eq)]
pub struct MaggError(String);

impl std::fmt::Display for MaggError {
  /// Implementation of [Display](std::fmt::Display) trait for [MaggError].
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    write!(f, "{}", self.0)
  }
}

impl MaggError {
  /// Creates a new [MaggError] with specified error message.
  pub fn new(message: impl AsRef<str>) -> Self {
    Self(message.as_ref().to_string())
  }
}

pub fn error_read_file(file_name: impl AsRef<Path>, reason: impl ToString) -> MaggError {
  MaggError::new(format!("failed to read file: {}, with reason: {}", file_name.as_ref().display(), reason.to_string()))
}

pub fn error_spawn_command(program: impl AsRef<str>, reason: impl AsRef<str>) -> MaggError {
  MaggError::new(format!("failed to spawn command: {}, with reason: {}", program.as_ref(), reason.as_ref()))
}

pub fn error_obtain_output(reason: impl AsRef<str>) -> MaggError {
  MaggError::new(format!("failed to obtain command output with reason: {}", reason.as_ref()))
}

pub fn error_execute_command(status: ExitStatus, stdout: impl AsRef<str>, stderr: impl AsRef<str>) -> MaggError {
  MaggError::new(format!(
    "failed to execute command, status {}\nstdout:\n{}\nstderr:\n{}\n",
    status,
    stdout.as_ref(),
    stderr.as_ref()
  ))
}