Struct helgoboss_midi::ParameterNumberMessageScanner

pub struct ParameterNumberMessageScanner { /* fields omitted */ }

Scanner for detecting (N)RPN messages in a stream of short messages.

Example

use helgoboss_midi::test_util::control_change;
use helgoboss_midi::{
    Channel, ControllerNumber, ParameterNumberMessage, ParameterNumberMessageScanner, U14,
};

let mut scanner = ParameterNumberMessageScanner::new();
let result_1 = scanner.feed(&control_change(0, 101, 3));
let result_2 = scanner.feed(&control_change(0, 100, 36));
let result_3 = scanner.feed(&control_change(0, 38, 24));
let result_4 = scanner.feed(&control_change(0, 6, 117));
assert_eq!(result_1, None);
assert_eq!(result_2, None);
assert_eq!(result_3, None);
assert_eq!(
    result_4,
    Some(ParameterNumberMessage::registered_14_bit(
        Channel::new(0),
        U14::new(420),
        U14::new(15000)
    ))
);

Implementations

impl ParameterNumberMessageScanner

pub fn new() -> ParameterNumberMessageScanner

Creates a new scanner.

pub fn feed(
    &mut self,
    msg: &impl ShortMessage
) -> Option<ParameterNumberMessage>

Feeds the scanner a single short message.

Returns the (N)RPN message if one has been detected.

pub fn reset(&mut self)

Resets the scanner discarding all intermediate scanning progress.

Trait Implementations

impl Clone for ParameterNumberMessageScanner

pub fn clone(&self) -> ParameterNumberMessageScanner

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ParameterNumberMessageScanner

impl Debug for ParameterNumberMessageScanner

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ParameterNumberMessageScanner

pub fn default() -> ParameterNumberMessageScanner

Returns the "default value" for a type.

impl Eq for ParameterNumberMessageScanner

impl PartialEq<ParameterNumberMessageScanner> for ParameterNumberMessageScanner

pub fn eq(&self, other: &ParameterNumberMessageScanner) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ParameterNumberMessageScanner) -> bool

This method tests for !=.

impl StructuralEq for ParameterNumberMessageScanner

impl StructuralPartialEq for ParameterNumberMessageScanner