midi2 0.11.1

Ergonomic, versatile, strong types wrapping MIDI 2.0 message data.
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

pub trait Property<B: crate::buffer::Buffer> {
    type Type;
}

pub trait ReadProperty<'a, B: crate::buffer::Buffer>: Property<B> {
    fn read(buffer: &'a B) -> Self::Type;
    // validate that the data in the buffer represents a valid instance of the property
    fn validate(buffer: &B) -> Result<(), crate::error::InvalidData>;
}

pub trait WriteProperty<B: crate::buffer::Buffer + crate::buffer::BufferMut>: Property<B> {
    fn write(buffer: &mut B, v: Self::Type);
    // validate that the value represents a valid instance of the property.
    // ideally the type system should do this for us so this will
    // most often just trivially return Ok
    //
    // This function is currently unused, but we'll keep it hangin' around
    // in case we need it sometime down the line.
    #[allow(dead_code)]
    fn validate(v: &Self::Type) -> Result<(), crate::error::InvalidData>;
    fn default() -> Self::Type;
}

// properties which may require resizing the underlying buffer
// before writing the value
pub trait ResizeProperty<B: crate::buffer::Buffer + crate::buffer::BufferMut>:
    WriteProperty<B>
{
    fn resize(buffer: &mut B, value: &Self::Type)
    where
        B: crate::buffer::BufferResize;
    fn try_resize(buffer: &mut B, value: &Self::Type) -> Result<(), crate::error::BufferOverflow>
    where
        B: crate::buffer::BufferTryResize;
}