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
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

use num_enum::{TryFromPrimitive, TryFromPrimitiveError};
use std::{
    fmt,
    io::{self, ErrorKind},
};
use thiserror::Error;

use super::Reader;

#[doc = r#"
A set of errors that can occur while reading something into a midi representation
"#]
#[derive(Error, Debug)]
pub enum ReaderError {
    /// Some io::Error
    #[error("{0}")]
    Io(#[from] io::Error),

    /// Unexpected out of bounds. Not necessarily IO related
    #[error("Out of bounds error: {0}")]
    OutOfBounds(String),

    /// Some Unknown error.
    #[error("Unknown error occurred")]
    Unknown,
}

impl ReaderError {
    /// True if out of bounds or unexpected end of file
    pub fn is_out_of_bounds(&self) -> bool {
        match self {
            Self::Io(o) => o.kind() == ErrorKind::UnexpectedEof,
            Self::OutOfBounds(_) => true,
            _ => false,
        }
    }

    /// Create a new invalid data error
    pub fn invalid_data(msg: impl fmt::Display) -> Self {
        Self::Io(io::Error::new(ErrorKind::InvalidData, msg.to_string()))
    }

    /// Create a new out of bounds error
    pub fn oob(msg: impl fmt::Display) -> Self {
        Self::OutOfBounds(msg.to_string())
    }
}

impl<T: TryFromPrimitive> From<TryFromPrimitiveError<T>> for ReaderError {
    fn from(value: TryFromPrimitiveError<T>) -> Self {
        // probably better way to handle this error. Please file
        // an issue if you have a suggestion!
        Self::oob(format!("{:?}", value))
    }
}

/// A result type that is either `T` or an [`io::Error`].
///
/// This may change in a future release if `midix`
/// should support `no-std` environments.
pub type ReadResult<T> = Result<T, ReaderError>;

pub(crate) fn unexp_eof() -> ReaderError {
    io::Error::new(ErrorKind::UnexpectedEof, "Read past the end of the file").into()
}

pub(crate) fn inv_data<R>(reader: &mut Reader<R>, v: impl fmt::Display) -> ReaderError {
    reader.set_last_error_offset(reader.buffer_position());
    io::Error::new(
        ErrorKind::InvalidData,
        format!("Cursor at {}: {}", reader.buffer_position(), v),
    )
    .into()
}
#[allow(dead_code)]
pub(crate) fn inv_input<R>(reader: &mut Reader<R>, v: impl fmt::Display) -> ReaderError {
    reader.set_last_error_offset(reader.buffer_position());
    io::Error::new(
        ErrorKind::InvalidInput,
        format!("Cursor at {}: {}", reader.buffer_position(), v),
    )
    .into()
}