Struct music_timer::time_signature::TimeSignature

pub struct TimeSignature { /* fields omitted */ }

Data structure of numerator(upper) and denominator(lower) values of music time signature

Methods

impl TimeSignature

pub fn new(numerator: u8, denominator: u8) -> TimeSignature

Create new signature with the defined numerator(upper) and denominator(lower) values.

Arguments

• numerator - The upper value of a time signature
• denominator - The lower value of a time signature

Example

let time_signature = music_timer::time_signature::TimeSignature::new(4, 4);

pub fn is_valid(&self) -> bool

Returns true if the time signature is valid. Current limitations of this crate recommend that denominator values should only be 2, 4, 8, 16 or 32. The numerator cannot be 0. It is your responsibility to create a valid TimeSignature.

pub fn get_numerator(&self) -> u8

Get the top value of the time signature.

pub fn get_denominator(&self) -> u8

Get the bottom value of the time signature.

pub fn as_tuple(&self) -> (u8, u8)

Trait Implementations

impl Clone for TimeSignature

fn clone(&self) -> TimeSignature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TimeSignature

impl Debug for TimeSignature

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

Formats the value using the given formatter.

impl Default for TimeSignature

fn default() -> TimeSignature

Returns the "default value" for a type.

impl PartialEq<TimeSignature> for TimeSignature

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

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

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

This method tests for !=.