honk-core 0.2.0

Core types and sound synthesis for honk
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

//! Error types for `honk-core`.
//!
//! A small `thiserror`-based enum to start from. Add variants as your tool
//! grows; the CLI converts these into `anyhow::Error` automatically via the
//! `?` operator.

use thiserror::Error;

/// Convenient result alias used throughout the core crate.
pub type Result<T> = std::result::Result<T, Error>;

/// Errors produced by the core crate.
#[derive(Debug, Error)]
pub enum Error {
    /// An I/O operation failed (reading/writing config, etc.).
    #[error("i/o error: {0}")]
    Io(#[from] std::io::Error),

    /// Failed to (de)serialize configuration.
    #[error("config error: {0}")]
    Config(String),

    /// A honk parameter is out of range.
    #[error("{0}")]
    InvalidSpec(String),

    /// Writing a WAV file failed.
    #[error("could not write WAV: {0}")]
    Wav(String),

    /// The platform did not expose a config directory.
    #[error("could not determine the configuration directory")]
    NoConfigDir,
}

impl From<serde_norway::Error> for Error {
    fn from(e: serde_norway::Error) -> Self {
        Error::Config(e.to_string())
    }
}