goonj 1.4.3

Goonj — acoustics engine for sound propagation, room simulation, and impulse response generation
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

use thiserror::Error;

/// Errors produced by goonj operations.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum GoonjError {
    /// Invalid room or wall geometry (e.g. too few vertices).
    #[error("invalid geometry: {0}")]
    InvalidGeometry(String),

    /// Invalid material parameters (e.g. absorption outside 0.0–1.0).
    #[error("invalid material: {0}")]
    InvalidMaterial(String),

    /// Invalid frequency value (e.g. negative Hz).
    #[error("invalid frequency: {0}")]
    InvalidFrequency(String),

    /// Sound propagation computation failed (reserved for future use).
    #[error("propagation failed: {0}")]
    PropagationFailed(String),

    /// General computation error (e.g. I/O failure during WAV export).
    #[error("computation error: {0}")]
    ComputationError(String),
}

/// Convenience result type for goonj operations.
pub type Result<T> = std::result::Result<T, GoonjError>;

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

    #[test]
    fn error_display() {
        let e = GoonjError::InvalidGeometry("no walls".into());
        assert_eq!(e.to_string(), "invalid geometry: no walls");
    }

    #[test]
    fn error_display_material() {
        let e = GoonjError::InvalidMaterial("negative absorption".into());
        assert!(e.to_string().contains("negative absorption"));
    }

    #[test]
    fn error_display_frequency() {
        let e = GoonjError::InvalidFrequency("below 0 Hz".into());
        assert!(e.to_string().contains("below 0 Hz"));
    }

    #[test]
    fn result_type_works() {
        let ok: Result<f32> = Ok(1.0);
        assert!(ok.is_ok());
        let err: Result<f32> = Err(GoonjError::ComputationError("fail".into()));
        assert!(err.is_err());
    }
}