midix 3.2.0

MIDI structures designed for humans
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

use crate::{
    Bytes,
    reader::{MidiSource, ReadResult, Reader},
};

#[doc = r#"
Identifies a chunk of a MIDI file that cannot be parsed.

It is up to the user for how to handle such chunks. Typically, these data are
ignored. However, sometimes there are particular use cases for handling
non-standard chunk types. We leave the option up to you.
"#]
#[derive(Clone, Debug, PartialEq)]
pub struct UnknownChunk<'a> {
    name: Bytes<'a>,
    inner: Bytes<'a>,
}

impl<'a> UnknownChunk<'a> {
    /// Place the bytes of an unknown chunk
    pub(crate) fn read<'slc, 'r, R>(name: Bytes<'a>, reader: &'r mut Reader<R>) -> ReadResult<Self>
    where
        R: MidiSource<'slc>,
        'slc: 'a,
    {
        let length = u32::from_be_bytes(*reader.read_exact_size()?);
        let data = reader.read_exact(length as usize)?;
        Ok(Self { name, inner: data })
    }

    /// Get the length of the unknown chunk
    pub fn len(&self) -> usize {
        self.inner.len()
    }

    /// Returns true when the bytes identified by the chunk is of length 0
    pub fn is_empty(&self) -> bool {
        self.inner.is_empty()
    }
}