Duration

Struct Duration 

Source
pub struct Duration {
    pub numerator: Numerator,
    pub denominator: Denominator,
    pub dots: Dots,
}
Expand description

Represents the duration of a musical note.

A duration combines:

  • Numerator: The note type (whole, half, quarter, etc.)
  • Denominator: The tuplet grouping (2 = normal, 3 = triplet, etc.)
  • Dots: Number of dots extending the duration

§Examples

// Quarter note
let quarter = Duration::new(
    Numerator::Quarter,
    Denominator::from_value(2).unwrap(),
    Dots::ZERO
);
assert_eq!(quarter.tick_length(), 240);

// Dotted quarter note
let dotted_quarter = Duration::new(
    Numerator::Quarter,
    Denominator::from_value(2).unwrap(),
    Dots::ONE
);
assert_eq!(dotted_quarter.tick_length(), 360);

Fields§

§numerator: Numerator

The note type (whole, half, quarter, etc.).

§denominator: Denominator

The tuplet denominator (2 = normal, 3 = triplet, etc.).

§dots: Dots

The number of dots (0-7).

Implementations§

Source§

impl Duration

Source

pub const TICK_RESOLUTION: i32 = 240i32

Ticks per quarter note (MIDI standard).

Source

pub const MAX_TICK_LENGTH: i32 = 1_920i32

Maximum tick length (whole note * 2).

Source

pub const MIN_DENOMINATOR: u8 = 2u8

Minimum denominator value.

Source

pub const MAX_DENOMINATOR: u8 = 255u8

Maximum denominator value.

Source

pub const MAX_DOT: u8 = 7u8

Maximum number of dots.

Source

pub const MAX_NUMERATOR: u8 = 7u8

Maximum numerator ordinal.

Source

pub fn new( numerator: Numerator, denominator: Denominator, dots: Dots, ) -> Duration

Creates a new duration.

§Arguments
  • numerator - The note type.
  • denominator - The tuplet denominator.
  • dots - The number of dots.
Source

pub const fn tick_length(self) -> u32

Calculates the duration in ticks.

§Returns

The duration in ticks, accounting for note type, tuplets, and dots.

Source

pub fn with_numerator(self, numerator: Numerator) -> Duration

Creates a new duration with a different numerator.

Source

pub fn with_denominator(self, denominator: Denominator) -> Duration

Creates a new duration with a different denominator.

Source

pub fn with_dots(self, dots: Dots) -> Duration

Creates a new duration with a different number of dots.

Source

pub fn min(self, other: Self) -> Self

Returns the shorter of two durations.

Trait Implementations§

Source§

impl Clone for Duration

Source§

fn clone(&self) -> Duration

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Duration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Duration

Source§

fn default() -> Duration

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Duration

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for Duration

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Duration

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Duration

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for Duration

Source§

impl Eq for Duration

Source§

impl StructuralPartialEq for Duration

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> OpaqueAttachment for T
where T: Send + Sync + 'static,