devela 0.28.0

A development substrate of coherence.
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

// devela::media::audio::format::raw::error
//
//! Defines [`PcmRawError`].
//

#[cfg(feature = "std")]
use crate::IoError;
#[cfg(feature = "std")]
use crate::IoErrorKind;

#[doc = crate::_tags!(audio error)]
/// Raw PCM encoding and decoding error.
#[doc = crate::_doc_meta!{location("media/audio"), test_size_of(PcmRawError = 1|8)}]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum PcmRawError {
    /// The PCM stream specification is incomplete or invalid.
    InvalidSpec,

    /// The byte length is not a multiple of the PCM frame size.
    InvalidDataLength,

    /// The PCM sample format does not match the requested operation.
    MismatchedSampleFormat,

    /// A typed sample value is outside the target PCM range.
    SampleOutOfRange,

    /// The destination buffer is too small.
    NotEnoughSpace,

    /// Reading or writing a file failed.
    #[cfg(feature = "std")]
    Io(IoErrorKind),
}

crate::impl_trait![fmt::Display+Error for PcmRawError |self, f| match self {
    Self::InvalidSpec => f.write_str("invalid raw PCM stream specification"),
    Self::InvalidDataLength => {
        f.write_str("raw PCM data length is not a multiple of frame size")
    }
    Self::MismatchedSampleFormat => {
        f.write_str("PCM sample format does not match the requested operation")
    }
    Self::SampleOutOfRange => f.write_str("PCM sample value is outside the target range"),
    Self::NotEnoughSpace => f.write_str("not enough space to write raw PCM data"),
    #[cfg(feature = "std")]
    Self::Io(err) => write!(f, "raw PCM file operation failed: {err}"),
}];

#[cfg(feature = "std")]
impl From<IoError> for PcmRawError {
    fn from(err: IoError) -> Self {
        Self::Io(err.kind())
    }
}