Struct midly::SmfBytemap

pub struct SmfBytemap<'a> {
    pub header: Header,
    pub tracks: Vec<BytemappedTrack<'a>>,
}

A .mid Standard Midi File, but keeps a mapping to the raw bytes that make up each event.

This type is only available with the alloc feature enabled.

Fields

header: Header

The header of this file.

tracks: Vec<BytemappedTrack<'a>>

A list of tracks, along with the bytemap of their events.

Implementations

impl<'a> SmfBytemap<'a>

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

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

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

Parse a Standard Midi File from its raw bytes, keeping a map to the original bytes that make up each event.

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

Encodes and writes the events (not the bytemap) to the given generic writer.

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

Encodes and writes the events (not the bytemap) to the given std::io::Write writer.

This function is only available with the std feature enabled.

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

Creates/overwrites the file at the given path and writes the events (not the bytemap) to it.

This function is only available with the std feature enabled.

Trait Implementations

impl<'a> Clone for SmfBytemap<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SmfBytemap<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for SmfBytemap<'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<SmfBytemap<'a>> for SmfBytemap<'a>

fn eq(&self, other: &SmfBytemap<'a>) -> bool

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

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

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

impl<'a> Eq for SmfBytemap<'a>

impl<'a> StructuralEq for SmfBytemap<'a>

impl<'a> StructuralPartialEq for SmfBytemap<'a>