nidhi 1.1.0

nidhi — Sample playback engine: key/velocity zones, loop modes, time-stretching, SFZ/SF2 import
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

//! Error types for the nidhi sampler engine.

use core::fmt;

/// Errors that can occur in nidhi operations.
#[derive(Debug, Clone)]
#[non_exhaustive]
#[must_use]
pub enum NidhiError {
    /// Sample not found in the bank.
    SampleNotFound(SampleId),
    /// Invalid zone configuration.
    InvalidZone(alloc::string::String),
    /// Invalid parameter value.
    InvalidParameter {
        name: alloc::string::String,
        reason: alloc::string::String,
    },
    /// Playback error.
    Playback(alloc::string::String),
    /// Format import error.
    ImportError(alloc::string::String),
}

use crate::sample::SampleId;

impl fmt::Display for NidhiError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::SampleNotFound(id) => write!(f, "sample not found: {}", id.0),
            Self::InvalidZone(msg) => write!(f, "invalid zone: {msg}"),
            Self::InvalidParameter { name, reason } => {
                write!(f, "invalid parameter '{name}': {reason}")
            }
            Self::Playback(msg) => write!(f, "playback error: {msg}"),
            Self::ImportError(msg) => write!(f, "import error: {msg}"),
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for NidhiError {}

/// Result type alias for nidhi operations.
pub type Result<T> = core::result::Result<T, NidhiError>;