wavekat-core 0.0.8

Shared types for the WaveKat audio processing ecosystem
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

/// Unified error type for `wavekat-core`.
///
/// Covers all fallible operations in this crate (currently WAV I/O).
/// Downstream crates can convert via `From<CoreError>` for ergonomic `?` usage.
///
/// # Variants
///
/// - [`Io`](CoreError::Io) — file or stream I/O failure
/// - [`Audio`](CoreError::Audio) — format or codec error (e.g. invalid WAV)
#[derive(Debug)]
pub enum CoreError {
    /// File or stream I/O failure.
    Io(std::io::Error),
    /// Audio format or codec error (e.g. unsupported WAV format).
    Audio(String),
}

impl std::fmt::Display for CoreError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            CoreError::Io(e) => write!(f, "{e}"),
            CoreError::Audio(msg) => write!(f, "{msg}"),
        }
    }
}

impl std::error::Error for CoreError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            CoreError::Io(e) => Some(e),
            CoreError::Audio(_) => None,
        }
    }
}

impl From<std::io::Error> for CoreError {
    fn from(e: std::io::Error) -> Self {
        CoreError::Io(e)
    }
}

#[cfg(feature = "wav")]
impl From<hound::Error> for CoreError {
    fn from(e: hound::Error) -> Self {
        match e {
            hound::Error::IoError(io) => CoreError::Io(io),
            other => CoreError::Audio(other.to_string()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::error::Error;

    #[test]
    fn display_io() {
        let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "file missing");
        let err = CoreError::Io(io_err);
        assert_eq!(err.to_string(), "file missing");
    }

    #[test]
    fn display_audio() {
        let err = CoreError::Audio("bad format".into());
        assert_eq!(err.to_string(), "bad format");
    }

    #[test]
    fn source_io_returns_inner() {
        let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "gone");
        let err = CoreError::Io(io_err);
        assert!(err.source().is_some());
    }

    #[test]
    fn source_audio_returns_none() {
        let err = CoreError::Audio("oops".into());
        assert!(err.source().is_none());
    }

    #[test]
    fn from_io_error() {
        let io_err = std::io::Error::new(std::io::ErrorKind::PermissionDenied, "denied");
        let err = CoreError::from(io_err);
        assert!(matches!(err, CoreError::Io(_)));
        assert_eq!(err.to_string(), "denied");
    }

    #[cfg(feature = "wav")]
    #[test]
    fn from_hound_io_error() {
        let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "not found");
        let hound_err = hound::Error::IoError(io_err);
        let err = CoreError::from(hound_err);
        assert!(matches!(err, CoreError::Io(_)));
        assert_eq!(err.to_string(), "not found");
    }

    #[cfg(feature = "wav")]
    #[test]
    fn from_hound_format_error() {
        let hound_err = hound::Error::Unsupported;
        let err = CoreError::from(hound_err);
        assert!(matches!(err, CoreError::Audio(_)));
    }
}