midi-io 0.1.0

Stream and send strictly-typed MIDI messages
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

#[cfg(target_os = "linux")]
use std::ffi::CStr;
use std::ffi::CString;

use crate::NameError;

#[derive(Clone, Debug)]
pub(crate) struct Name(CString);

impl TryFrom<&str> for Name {
    type Error = NameError;

    fn try_from(name: &str) -> Result<Self, Self::Error> {
        Ok(Self(CString::new(name)?))
    }
}

impl Name {
    pub(crate) fn as_str(&self) -> &str {
        self.0
            .to_str()
            .expect("Name is only constructed from &str, so it is valid UTF-8")
    }

    #[cfg(target_os = "linux")]
    pub(crate) fn as_c_str(&self) -> &CStr {
        &self.0
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn try_from_rejects_interior_nul() {
        assert!(matches!(
            Name::try_from("bad\0name"),
            Err(NameError::ContainsNul(_))
        ));
    }

    #[test]
    fn try_from_rejects_leading_and_trailing_nul() {
        assert!(Name::try_from("\0name").is_err());
        assert!(Name::try_from("name\0").is_err());
    }

    #[test]
    fn as_str_round_trips() {
        let name = Name::try_from("midi-io client").expect("valid name");
        assert_eq!(name.as_str(), "midi-io client");
    }

    #[test]
    fn as_str_round_trips_non_ascii_utf8() {
        let name = Name::try_from("sinté 🎹").expect("valid name");
        assert_eq!(name.as_str(), "sinté 🎹");
    }

    #[cfg(target_os = "linux")]
    #[test]
    fn as_c_str_is_nul_terminated_original() {
        let name = Name::try_from("alsa client").expect("valid name");
        assert_eq!(name.as_c_str(), c"alsa client");
    }
}