Skip to main content

mac_sys_info/
error.rs

1/*
2MIT License
3
4Copyright (c) 2020 Philipp Schuster
5
6Permission is hereby granted, free of charge, to any person obtaining a copy
7of this software and associated documentation files (the "Software"), to deal
8in the Software without restriction, including without limitation the rights
9to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10copies of the Software, and to permit persons to whom the Software is
11furnished to do so, subject to the following conditions:
12
13The above copyright notice and this permission notice shall be included in all
14copies or substantial portions of the Software.
15
16THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22SOFTWARE.
23*/
24//! Contains all error-related structs and functions that can occur in this library.
25
26use crate::generated_sysctl_keys::SysctlKey;
27use derive_more::Display;
28use std::error::Error;
29use unix_exec_output_catcher::error::UECOError;
30
31/// Errors that can happen inside the library.
32#[derive(Debug, Display)]
33pub enum MacSysInfoError {
34    #[display(fmt = "Can't fetch system data because the library reported the error: {}", _0)]
35    CantFetchData(UECOError),
36    #[display(fmt = "Could not capture any stdout lines from `$ sysctl -a` execution. There might be an error in crate 'unix-exec-output-catcher'.")]
37    NoCapturedOutput,
38    #[display(fmt = "Can't parse key '{}' for field '{}' because of: '{}'", sysctl_key, field_name, err_msg)]
39    ParseError{field_name: String, sysctl_key: SysctlKey, err_msg: String},
40    #[display(fmt = "The key '{}' can't be found in \"sysctl -a\" output.", _0)]
41    KeyNotFound(SysctlKey),
42}
43
44// IDE might show that display is not implemented but it gets implemented
45// during build by "derive_more" crate
46impl Error for MacSysInfoError {
47
48    fn source(&self) -> Option<&(dyn Error + 'static)> {
49        match self {
50            MacSysInfoError::CantFetchData(inner) => {
51                Some(inner)
52            },
53            _ => None
54        }
55    }
56}