Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add basic defmt support with feature gate #20

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ version = "4.0.10"
bench = false

[dependencies]
defmt = { version = "0.3.5", optional = true }

[dev-dependencies]
criterion = "0.3"
Expand All @@ -23,6 +24,7 @@ criterion = "0.3"
# Meta-features:
default = ["std"] # Without "std", wmidi uses libcore.
std = []
defmt-03 = ["dep:defmt"]

[[bench]]
harness = false
Expand Down
2 changes: 2 additions & 0 deletions src/byte.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use crate::Error;
use core::convert::TryFrom;

/// A data byte that holds 7 bits of information.
#[cfg_attr(feature="defmt-03", derive(defmt::Format))]
#[derive(Copy, Clone, Debug, Default, Eq, Hash, PartialEq, PartialOrd, Ord)]
pub struct U7(pub(crate) u8);

Expand Down Expand Up @@ -80,6 +81,7 @@ impl TryFrom<u8> for U7 {
}

/// A combination of 2 data bytes that holds 14 bits of information.
#[cfg_attr(feature="defmt-03", derive(defmt::Format))]
#[derive(Copy, Clone, Debug, Default, Eq, Hash, PartialEq, PartialOrd, Ord)]
pub struct U14(u16);

Expand Down
1 change: 1 addition & 0 deletions src/cc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ use crate::byte::U7;
///
/// Channel mode messages affect the entire instrument and
/// are only valid when sent over the instrument's "basic channel".
#[cfg_attr(feature="defmt-03", derive(defmt::Format))]
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq, PartialOrd, Ord)]
pub struct ControlFunction(pub U7);

Expand Down
2 changes: 2 additions & 0 deletions src/midi_message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use core::convert::TryFrom;
use std::{io, vec::Vec};

/// Holds information based on the Midi 1.0 spec.
#[cfg_attr(feature="defmt-03", derive(defmt::Format))]
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum MidiMessage<'a> {
/// This message is sent when a note is released (ended).
Expand Down Expand Up @@ -398,6 +399,7 @@ pub type Song = U7;

/// The MIDI channel. There are 16 channels. They are numbered between 1 and 16
/// inclusive, or indexed between 0 and 15 inclusive.
#[cfg_attr(feature="defmt-03", derive(defmt::Format))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Channel {
Ch1,
Expand Down
1 change: 1 addition & 0 deletions src/note.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ use core::fmt;
/// assert_eq!(Note::from_u8_lossy(48), Note::C3);
/// ```
#[repr(u8)]
#[cfg_attr(feature="defmt-03", derive(defmt::Format))]
#[derive(Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum Note {
CMinus1 = 0,
Expand Down