daktilo_lib 0.5.0

Turn your keyboard into a typewriter! 📇
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use thiserror::Error as ThisError;

/// Custom error type.
#[derive(Debug, ThisError)]
pub enum Error {
    /// Error that may occur during I/O operations.
    #[error("IO error: `{0}`")]
    Io(#[from] std::io::Error),

    /// Error that may occur during audio streams.
    #[error("Stream error: `{0}`")]
    Stream(#[from] rodio::StreamError),

    /// Error that may occur while decoding data.
    #[error("Decode error: `{0}`")]
    Decode(#[from] rodio::decoder::DecoderError),

    /// Error that may occur during playing audio.
    #[error("Play error: `{0}`")]
    Play(#[from] rodio::PlayError),

    /// Error that might occur while attempting to enumerate the available devices on a system.
    #[error("Device error: `{0}`")]
    Devices(#[from] rodio::DevicesError),

    /// Error that may occur while attempting to retrieve a device name.
    #[error("Device name error: `{0}`")]
    DeviceName(#[from] rodio::cpal::DeviceNameError),

    /// Error that may occur when a device is not found.
    #[error("`{0}` output device not found.")]
    DeviceNotFound(String),

    /// Error that may occur while extracting the embedded content.
    #[error("Embedded error: `{0}`")]
    Embedded(String),

    /// Error that may occur while parsing a filtering directive.
    #[error("Log directive parse error: `{0}`")]
    DirectiveParse(#[from] tracing_subscriber::filter::ParseError),

    /// Error that may occur while parsing TOML.
    #[error("TOML parse error: `{0}`")]
    TomlParse(#[from] toml::de::Error),

    /// Error that may occur when attempting to interpret a sequence of u8 as a
    /// string.
    #[error("UTF-8 error: `{0}`")]
    Utf8(#[from] std::str::Utf8Error),

    /// Error that may occur when a preset is not found.
    #[error("Preset not found: `{0}`")]
    PresetNotFound(String),

    /// Error that may occur when no audio files are given.
    #[error("No audio files to play")]
    NoAudioFiles,

    /// Error that may occur when parsing regexes.
    #[error("Regex: `{0}`")]
    Regex(#[from] regex::Error),
}

/// Type alias for the standard [`Result`] type.
pub type Result<T> = std::result::Result<T, Error>;

#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;
    use std::io::{Error as IoError, ErrorKind};

    #[test]
    fn test_error() {
        let message = "your computer is on fire!";
        let error = Error::from(IoError::new(ErrorKind::Other, message));
        assert_eq!(format!("IO error: `{message}`"), error.to_string());
        assert_eq!(
            format!("\"IO error: `{message}`\""),
            format!("{:?}", error.to_string())
        );
    }
}