Struct libatm::midi_note::MIDINoteVec

pub struct MIDINoteVec(pub Vec<MIDINote>);

Container for vector of MIDINote

Implements the FromStr trait as a convenience method for parsing a list of MIDINote (from a command line argument).

Examples

// Parse MIDI note set from &str
let note_set = "C:4,D:5,CSharp:8,DSharp:3".parse::<libatm::MIDINoteVec>().unwrap();
// Expected note set contains C:4, D:5, CSharp:8, and DSharp:3
let expected = libatm::MIDINoteVec(vec![
    libatm::MIDINote::new(libatm::MIDINoteType::C, 4),
    libatm::MIDINote::new(libatm::MIDINoteType::D, 5),
    libatm::MIDINote::new(libatm::MIDINoteType::CSharp, 8),
    libatm::MIDINote::new(libatm::MIDINoteType::DSharp, 3),
]);
assert_eq!(expected, note_set);

Methods from Deref<Target = Vec<MIDINote>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector's buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl From<MIDINoteSet> for MIDINoteVec

fn from(set: MIDINoteSet) -> Self

Performs the conversion.

impl<'_> From<&'_ MIDINoteSet> for MIDINoteVec

fn from(set: &MIDINoteSet) -> Self

Performs the conversion.

impl Clone for MIDINoteVec

fn clone(&self) -> MIDINoteVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<MIDINoteVec> for MIDINoteVec

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

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

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

This method tests for !=.

impl Debug for MIDINoteVec

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl FromStr for MIDINoteVec

type Err = ParseMIDINoteSequenceError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Deref for MIDINoteVec

type Target = Vec<MIDINote>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Allow dereferencing of tuple struct to underlying hash set

impl StructuralPartialEq for MIDINoteVec

impl FromIterator<MIDINote> for MIDINoteVec

fn from_iter<I: IntoIterator<Item = MIDINote>>(iter: I) -> Self

Creates a value from an iterator.