ironic 0.2.4

A batteries-included, type-safe application framework for Rust
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
47
48
49
50
51
52
53
54
55

use std::{io, path::PathBuf};

/// A command-line operation failure.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum CliError {
    /// A filesystem operation failed.
    #[error("RF_CLI_IO: {action} `{path}`: {source}")]
    Io {
        /// Description of the attempted operation.
        action: &'static str,
        /// Affected path.
        path: PathBuf,
        /// Underlying I/O failure.
        source: io::Error,
    },
    /// A generator name cannot be mapped safely to Rust and package identifiers.
    #[error("RF_CLI_INVALID_NAME: `{name}` cannot form a safe Rust identifier")]
    InvalidName {
        /// Rejected user input.
        name: String,
    },
    /// A generated file exists with different content.
    #[error("RF_CLI_FILE_CONFLICT: refusing to overwrite `{path}`")]
    FileConflict {
        /// Conflicting file.
        path: PathBuf,
    },
    /// A Rust source file could not be parsed safely.
    #[error("RF_CLI_SOURCE_PARSE: cannot safely update `{path}`: {message}")]
    SourceParse {
        /// Source file.
        path: PathBuf,
        /// Parser diagnostic.
        message: String,
    },
    /// A child Cargo or tool command failed.
    #[error("RF_CLI_COMMAND_FAILED: `{program}` exited with status {status}")]
    CommandFailed {
        /// Executed program.
        program: String,
        /// Process exit status or signal description.
        status: String,
    },
}

impl CliError {
    pub(crate) fn io(action: &'static str, path: impl Into<PathBuf>, source: io::Error) -> Self {
        Self::Io {
            action,
            path: path.into(),
            source,
        }
    }
}