rfham-core 0.1.1

Core data types for RF-Ham libraries.
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

//! Error and result types for `rfham-core`.
//!
//! [`CoreError`] is the single error enum used across all modules in this crate.
//! [`Result<T>`] is a type alias for `std::result::Result<T, CoreError>`.

use thiserror::Error;

#[cfg(feature = "std")]
use std::io::Error as IoError;

#[cfg(feature = "std")]
use std::string::FromUtf8Error;

#[cfg(not(feature = "std"))]
use alloc::string::FromUtf8Error;

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

///
/// The `Error` type for this crate.
///
#[derive(Debug, Error)]
pub enum CoreError {
    #[error("Unable to parse string as `{1}`; value: {0:?}")]
    InvalidValueFromStr(String, &'static str),

    #[error("Value `{0}` is not valid for type `{1}`")]
    InvalidValue(String, &'static str),

    #[error("Unable to convert from UTF-8 to string; error: {0}")]
    FromUtf(#[from] FromUtf8Error),

    #[cfg(feature = "std")]
    #[error("An I/O error occurred; error: {0}")]
    Io(#[from] IoError),
}

///
/// A `Result` type that specifically uses this crate's `Error`.
///
pub type Result<T> = std::result::Result<T, CoreError>;