Struct midi_file::Settings

pub struct Settings { /* fields omitted */ }

Optionally provide settings to the MidiFile. This is a ‘builder’ struct.

Example

use midi_file::{MidiFile, Settings};
use midi_file::file::{Format, Division, QuarterNoteDivision};

let settings = Settings::new()
    .running_status(true)
    .format(Format::Single)
    .divisions(Division::QuarterNote(QuarterNoteDivision::new(244)));
let _m = MidiFile::new_with_settings(settings);

Implementations

impl Settings

pub fn new() -> Self

Create a Settings object with default settings.

pub fn running_status(self, value: bool) -> Self

Set the running_status setting. When this is true, the MidiFile will not write redundant status bytes.

pub fn format(self, value: Format) -> Self

Set the format setting. MIDI files can be one of three types, see Format.

pub fn divisions(self, value: Division) -> Self

Set the division setting, see Division.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Settings

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Settings

impl Hash for Settings

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Settings

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Settings> for Settings

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

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

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

This method tests for !=.

impl PartialOrd<Settings> for Settings

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Settings

impl StructuralPartialEq for Settings