Struct Smf

pub struct Smf<'a> {
    pub header: Header,
    pub tracks: Vec<Track<'a>>,
}

Represents a single .mid Standard Midi File. If you’re casually looking to parse a .mid file, this is the type you’re looking for.

This type is only available with the alloc feature enabled. If you’re looking for a fully no_std alternative, see the parse function.

Fields

header: Header

The header of this MIDI file, indicating tempo information and track format.

tracks: Vec<Track<'a>>

A list of tracks within this MIDI file.

Each track consists simply of a list of events (ie. there is no track metadata).

Implementations

impl<'a> Smf<'a>

pub fn new(header: Header) -> Smf<'a>

Create a new empty Smf with zero tracks, using the given header.

pub fn parse(raw: &[u8]) -> Result<Smf<'_>>

Parse a .mid Standard Midi File from its raw bytes. If you casually want to parse .mid files, this is the function you’re looking for.

pub fn write<W: Write>(&self, out: &mut W) -> WriteResult<W>

Encodes and writes the file to the given generic writer.

Note that this function requires a midly::io::Write writer, not a std::io::Write writer. This makes it possible to support no_std environments, as well as custom writer errors. If you’re looking to write to a File, see the save method. If you’re looking to write to a std::io::Write writer, see the write_std method.

This function is always available, even in no_std environments.

pub fn write_std<W: Write>(&self, out: W) -> Result<()>

Encodes and writes the file to the given std::io::Write writer.

This function is similar to the write method, but writes to a std::io::Write writer instead of a midly::io::Write writer.

This function is only available with the std feature enabled.

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

Encodes and writes the file to the given path.

This function is only available with the std feature enabled.

pub fn to_static(&self) -> Smf<'static>

Remove any lifetimed data from this event to create an Smf with 'static lifetime that can be stored and moved everywhere, solving borrow checker issues.

This method creates a copy of the Smf structure. See the make_static method for an in-place solution.

WARNING: Any bytestrings, including meta messages, SysEx dumps and escape sequences will be replaced by empty bytestrings.

pub fn make_static(self) -> Smf<'static>

Remove any lifetimed data from this event to create an Smf with 'static lifetime that can be stored and moved everywhere, solving borrow checker issues.

This method consumes the Smf structure, reusing the backing memory.

WARNING: Any bytestrings, including meta messages, SysEx dumps and escape sequences will be replaced by empty bytestrings.

Trait Implementations

impl<'a> Clone for Smf<'a>

fn clone(&self) -> Smf<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Smf<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Smf<'a>

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<'a> PartialEq for Smf<'a>

fn eq(&self, other: &Smf<'a>) -> 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<'a> Eq for Smf<'a>

impl<'a> StructuralPartialEq for Smf<'a>