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

// devela::data::codec::pack::wrap::riff::error
//
//! Defines [`RiffError`].
//

#[cfg(feature = "audio")]
use crate::PcmWavError;

#[doc = crate::_tags!(data codec error)]
/// RIFF parsing error.
#[doc = crate::_doc_meta!{location("data/codec/pack")}]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum RiffError {
    /// The chunk header is incomplete.
    TruncatedHeader,
    /// The declared chunk data is incomplete.
    TruncatedData,
    /// The declared pad byte is incomplete.
    TruncatedPad,
    /// A size computation overflowed.
    Overflow,
    /// The root chunk is not `RIFF`.
    NotRiff,
    /// The destination buffer is too small.
    NotEnoughSpace,
    /// The root chunk is `RIFX`, which is not supported yet.
    UnsupportedRifx,
    /// A container chunk is missing its form/list type.
    MissingContainerType,
}
crate::impl_trait![fmt::Display+Error for RiffError |self, f| match self {
    Self::TruncatedHeader => f.write_str("incomplete RIFF chunk header"),
    Self::TruncatedData => f.write_str("incomplete RIFF chunk data"),
    Self::TruncatedPad => f.write_str("missing RIFF chunk pad byte"),
    Self::Overflow => f.write_str("RIFF chunk size computation overflowed"),
    Self::NotEnoughSpace => f.write_str("not enough space to write RIFF data"),
    Self::NotRiff => f.write_str("root chunk is not `RIFF`"),
    Self::UnsupportedRifx => f.write_str("`RIFX` big-endian RIFF is not supported"),
    Self::MissingContainerType => f.write_str("RIFF container chunk is missing its form/list type"),
}];
impl RiffError {
    /// Converts the error into a WAVE error.
    #[cfg(feature = "audio")]
    pub const fn to_wav(self) -> PcmWavError {
        PcmWavError::Riff(self)
    }
}