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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

# System Exclusive 7Bit

A semantic wrapper type around MIDI system exclusive 7bit data.

## Abstract over [Buffer](crate::buffer::Buffer)

Use it with a [Ump](crate::buffer::Ump) buffer.

```rust
use midi2::prelude::*;

let mut message = sysex7::Sysex7::<Vec<u32>>::new();
message.set_payload((0u8..30u8).map(u7::new));
message.set_group(u4::new(0xA));

assert_eq!(
    message.data(),
    &[
        0x3A16_0001,
        0x0203_0405,
        0x3A26_0607,
        0x0809_0A0B,
        0x3A26_0C0D,
        0x0E0F_1011,
        0x3A26_1213,
        0x1415_1617,
        0x3A36_1819,
        0x1A1B_1C1D,
    ],
);
```

Or use it with a [Bytes](crate::buffer::Bytes) buffer.

```rust
use midi2::prelude::*;

let mut message = sysex7::Sysex7::<Vec<u8>>::new();
message.set_payload((0u8..30u8).map(u7::new));

assert_eq!(
    message.data(),
    &[
        0xF0, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C,
        0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A,
        0x1B, 0x1C, 0x1D, 0xF7,
    ],
);
```

## Borrowed workflow

You can create a [Sysex7] from
borrowed data and avoid copying or allocating if you have the data already existing
in a buffer.

```rust
use midi2::prelude::*;

let buffer = [
    0x3416_0001_u32,
    0x0203_0405_u32,
    0x3426_0607_u32,
    0x0809_0A0B_u32,
    0x3433_0C0D_u32,
    0x0E00_0000_u32,
];

let borrowed = sysex7::Sysex7::try_from(&buffer[..])
    .expect("Data is valid");

assert_eq!(
    borrowed.data(),
    &[
        0x3416_0001_u32,
        0x0203_0405_u32,
        0x3426_0607_u32,
        0x0809_0A0B_u32,
        0x3433_0C0D_u32,
        0x0E00_0000_u32,
    ],
);

// Borrowed messages are immutable and their lifetimes are
// tied to the original buffer. 
//
// To create an owned version use the `Rebuffer` traits.

let mut owned: sysex7::Sysex7::<Vec<u32>> = borrowed.rebuffer_into();
owned.set_group(u4::new(0x5));

assert_eq!(
    owned.data(),
    &[
        0x3516_0001_u32,
        0x0203_0405_u32,
        0x3526_0607_u32,
        0x0809_0A0B_u32,
        0x3533_0C0D_u32,
        0x0E00_0000_u32,
    ],
);
```

## Fixed size buffers

Use with fixed size, or fallible buffers.

```rust
use midi2::prelude::*;

let mut message = sysex7::Sysex7::<[u8; 22]>::new();

// only fallible methods are available
assert_eq!(message.try_set_payload((0u8..20u8).map(u7::new)), Ok(()));
assert_eq!(
    message.data(), 
    &[
        0xF0, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C,
        0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0xF7,
    ],
);

// setting payloads larger than the available size will fail
assert_eq!(
    message.try_set_payload((0u8..30u8).map(u7::new)),
    Err(midi2::error::BufferOverflow),
);
assert_eq!(message.data(), &[0xF0, 0xF7]);
```