bt-rs 0.0.2

Build tools, 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
56
57
58
59
60
61
62
63
64

// version_error.rs : src/common

use std::{
    error as std_error,
    fmt as std_fmt,
    io as std_io,
};


/// Failure to obtain or parse a tool's `--version` output.
#[derive(Debug)]
pub enum VersionError {
    /// Failed to execute the tool with `--version`.
    InvocationFailed(std_io::Error),
    /// Tool `--version` stdout was not valid UTF-8.
    InvalidUtf8,
    /// Output did not contain a recognisable version token.
    UnrecognisedOutput,
    /// A major, minor, or patch component was not a valid unsigned integer.
    InvalidVersionComponent {
        component : &'static str,
        value :     String,
    },
}


// Trait implementations

impl std_fmt::Display for VersionError {
    fn fmt(
        &self,
        f : &mut std_fmt::Formatter<'_>,
    ) -> std_fmt::Result {
        match self {
            Self::InvocationFailed(e) => {
                write!(f, "failed to execute tool `--version`: {e}")
            },
            Self::InvalidUtf8 => {
                write!(f, "tool `--version` stdout was not valid UTF-8")
            },
            Self::UnrecognisedOutput => {
                write!(f, "tool `--version` output was not recognised")
            },
            Self::InvalidVersionComponent { component, value } => {
                write!(
                    f,
                    "invalid {component} component in tool `--version` output: {value:?}"
                )
            },
        }
    }
}

impl std_error::Error for VersionError {
    fn source(&self) -> Option<&(dyn std_error::Error + 'static)> {
        match self {
            Self::InvocationFailed(e) => Some(e),
            _ => None,
        }
    }
}


// ///////////////////////////// end of file //////////////////////////// //