Struct MidiFile

pub struct MidiFile { /* private fields */ }

Represents a MIDI file, which consists of a header identifying the type of MIDI file, and tracks with MIDI data.

Implementations

impl MidiFile

pub fn new() -> Self

Create a new MidiFile with reasonable default Settings.

pub fn header(&self) -> &Header

A getter for the header field.

pub fn running_status(&self) -> bool

A getter for the running_status field.

pub fn new_with_settings(settings: Settings) -> Self

Create a new MidiFile with customizable Settings.

pub fn read<R: Read>(r: R) -> Result<Self>

Read a MidiFile from bytes.

pub fn load<P: AsRef<Path>>(file: P) -> Result<Self>

Load a MidiFile from a file path.

pub fn write<W: Write>(&self, w: &mut W) -> Result<()>

Write a MidiFile to bytes.

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save a MidiFile to a file path.

pub fn tracks_len(&self) -> u32

The number of tracks, i.e. the length of the vector of tracks.

pub fn tracks(&self) -> impl Iterator<Item = &Track>

An iterator over the tracks in the file.

pub fn track(&self, index: u32) -> Option<&Track>

Get a reference to the track at index if it exists.

pub fn push_track(&mut self, track: Track) -> Result<()>

Add a track to the file.

pub fn insert_track(&mut self, index: u32, track: Track) -> Result<()>

Insert a track at a certain place in the vector of tracks.

pub fn remove_track(&mut self, index: u32) -> Result<Track>

Remove a track from the file. Same behavior as vec.remove(index).

Trait Implementations

impl Clone for MidiFile

fn clone(&self) -> MidiFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MidiFile

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

Formats the value using the given formatter.

impl Default for MidiFile

fn default() -> Self

Returns the “default value” for a type.

impl Hash for MidiFile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MidiFile

fn cmp(&self, other: &MidiFile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MidiFile

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MidiFile

fn partial_cmp(&self, other: &MidiFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for MidiFile

impl StructuralPartialEq for MidiFile