ghurni 1.0.0

ghurni — Mechanical sound synthesis: engines, gears, motors, turbines, RPM-driven harmonics
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

//! Error types for the ghurni crate.

use alloc::string::String;
use serde::{Deserialize, Serialize};

/// Errors that can occur during mechanical sound synthesis.
#[derive(Debug, Clone, Serialize, Deserialize, thiserror::Error)]
#[non_exhaustive]
pub enum GhurniError {
    /// A parameter is out of valid range.
    #[error("invalid parameter: {0}")]
    InvalidParameter(String),

    /// A synthesis operation failed.
    #[error("synthesis failed: {0}")]
    SynthesisFailed(String),

    /// A computation produced an invalid result.
    #[error("computation error: {0}")]
    ComputationError(String),
}

/// Convenience type alias for ghurni results.
pub type Result<T> = core::result::Result<T, GhurniError>;