Struct TimeSignature 

pub struct TimeSignature { /* private fields */ }

A time signature, such as 4/4 or 6/8.

use music21_rs::TimeSignature;

let six_eight = TimeSignature::from_ratio_string("6/8")?;
assert_eq!(six_eight.beat_count(), 2);
assert_eq!(six_eight.beat_quarter_length(), 1.5);
assert_eq!(six_eight.classification(), "Compound Duple");

Implementations

impl TimeSignature

pub fn new( numerator: UnsignedIntegerType, denominator: UnsignedIntegerType, ) -> Result<Self>

Creates a time signature from a numerator and denominator.

Both must be non-zero. The denominator need not be a power of two — music21 accepts irrational meters such as 4/3, and so does this.

pub fn from_ratio_string(ratio: &str) -> Result<Self>

Parses a "numerator/denominator" string such as "6/8".

pub fn common() -> Self

Returns common time, 4/4.

pub fn cut() -> Self

Returns cut time, 2/2.

pub fn numerator(self) -> UnsignedIntegerType

Returns the numerator.

pub fn denominator(self) -> UnsignedIntegerType

Returns the denominator.

pub fn ratio_string(self) -> String

Returns the "numerator/denominator" spelling.

pub fn bar_quarter_length(self) -> FloatType

Returns the length of one bar in quarter lengths.

pub fn bar_duration(self) -> Duration

Returns the length of one bar as a Duration.

pub fn beat_count(self) -> UnsignedIntegerType

Returns how many beats one bar carries.

This is music21’s beatCount, which follows the numerator rather than the denominator — except at 3, where 3/4 is three beats but 3/8 is one.

pub fn beat_count_name(self) -> String

Returns music21’s name for the beat count, such as "Duple".

Counts above eight are spelled as "<n>-uple", as music21 does.

pub fn beat_quarter_length(self) -> FloatType

Returns the length of one beat in quarter lengths.

Every meter this type can express has a uniform beat, so unlike music21’s beatDuration this never fails. music21 only reports a non-uniform beat for a hand-partitioned MeterSequence, which has no counterpart here.

pub fn beat_duration(self) -> Duration

Returns the length of one beat as a Duration.

pub fn beat_division(self) -> BeatDivision

Returns how the beat subdivides.

pub fn beat_division_count(self) -> UnsignedIntegerType

Returns the number of divisions in one beat.

pub fn is_compound(self) -> bool

Returns true when beats divide in three.

pub fn classification(self) -> String

Returns music21’s classification, such as "Compound Duple".

pub fn beat_offsets(self) -> Vec<FloatType>

Returns the quarter-length offset of each beat within one bar.

pub fn beat_at_offset(self, offset: FloatType) -> Result<UnsignedIntegerType>

Returns the one-based beat containing offset quarter lengths into a bar.

Matches music21’s getBeat. Offsets at or beyond the end of the bar are rejected rather than wrapping.

Trait Implementations

impl Clone for TimeSignature

fn clone(&self) -> TimeSignature

Returns a duplicate 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() -> Self

Returns 4/4, matching music21’s default TimeSignature().

impl Display for TimeSignature

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

Formats the value using the given formatter.

impl Eq for TimeSignature

impl Hash for TimeSignature

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 PartialEq for TimeSignature

fn eq(&self, other: &TimeSignature) -> 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 StructuralPartialEq for TimeSignature