Struct TimeSignature

pub struct TimeSignature { /* private fields */ }

Represents a time signature.

Internally, it stores the number of notes in a measure and the beat value.

Implementations

impl TimeSignature

pub const COMMON_TIME: Self

4/4 time signature

pub const CUT_TIME: Self

2/2 time signature

pub const fn new(notes: u64, beat_value: u64) -> Self

Create a new time signature. It takes the number of notes in a measure and the beat value.

Examples

use note_pen::prelude::*;
let time_signature = TimeSignature::new(4, 4);
assert_eq!(time_signature, TimeSignature::COMMON_TIME);
let time_signature = TimeSignature::new(2, 2);
assert_eq!(time_signature, TimeSignature::CUT_TIME);

pub const fn simple(beats: u64, value: PrimitiveDuration) -> Self

Create a simple time signature.

pub const fn compound(beats: u64, value: PrimitiveDuration) -> Self

Create a compound time signature.

Examples

use note_pen::prelude::*;
// 6/8 time signature
let time_signature = TimeSignature::compound(2, PrimitiveDuration::EIGHTH);
let expected = TimeSignature::new(6, 8);
assert_eq!(time_signature, expected);

pub const fn is_compound(&self) -> bool

Check if the time signature is compound.

Examples

use note_pen::prelude::*;
let time_signature = TimeSignature::new(6, 8);
assert!(time_signature.is_compound());

pub const fn is_simple(&self) -> bool

Check if the time signature is simple.

Examples

use note_pen::prelude::*;
let time_signature = TimeSignature::new(4, 4);
assert!(time_signature.is_simple());
let time_signature = TimeSignature::new(5, 4);
assert!(time_signature.is_simple());

pub const fn beats(&self) -> u64

Get the number of beats in a measure. For compound time signatures, it returns the number of dotted notes – the number of notes in a measure divided by 3.

Examples

use note_pen::prelude::*;
let time_signature = TimeSignature::new(6, 8);
assert_eq!(time_signature.beats(), 2);
let time_signature = TimeSignature::new(4, 4);
assert_eq!(time_signature.beats(), 4);

pub fn value(&self) -> PrimitiveDuration

Get the beat value.

Examples

use note_pen::prelude::*;
let time_signature = TimeSignature::new(6, 8);
assert_eq!(time_signature.value(), PrimitiveDuration::EIGHTH);
let time_signature = TimeSignature::new(4, 4);
assert_eq!(time_signature.value(), PrimitiveDuration::QUARTER);

Panics

It panics if the beat value is invalid and PrimitiveDuration::try_from returns an error.

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

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

Formats the value using the given formatter.

impl PartialEq for TimeSignature

fn eq(&self, other: &Self) -> 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.