Skip to main content

Beat

Struct Beat 

Source
pub struct Beat {
    pub num: i64,
    pub den: u32,
}
Expand description

An exact musical position or duration as a rational number of beats: num / den, always normalized (denominator positive, gcd-reduced, zero canonicalized to 0/1). Tuplets and repeated transforms (stretch, rotate, concatenate) stay exact — no floating-point drift ever accumulates before the frame boundary.

Beat::new(2, 4) IS Beat::new(1, 2). A zero den is floored to 1 (the same degenerate-value clamp the song grid applies), so deserialization can never produce a division by zero. Serde is the flat struct {"num":..,"den":..}; deserializing normalizes through Beat::new.

Fields§

§num: i64

The numerator (beats × den), carries the sign.

§den: u32

The denominator, always > 0 after normalization.

Implementations§

Source§

impl Beat

Source

pub const fn new(num: i64, den: u32) -> Beat

A normalized beat: gcd-reduced, den > 0, zero as 0/1. A den of 0 is floored to 1.

Source

pub const fn zero() -> Beat

Zero beats — the origin of the musical timeline.

Source

pub const fn from_int(n: i64) -> Beat

A whole number of beats (n/1).

Source

pub fn checked_add(self, other: Beat) -> Result<Beat, BeatError>

Exact sum, erroring when the (unreduced) result doesn’t fit a Beat.

Source

pub fn checked_sub(self, other: Beat) -> Result<Beat, BeatError>

Exact difference, erroring when the (unreduced) result doesn’t fit a Beat.

Source

pub fn mul_rational(self, num: i64, den: u32) -> Result<Beat, BeatError>

Exact scaling by the rational factor num / den, erroring when the (unreduced) result doesn’t fit a Beat.

Source

pub fn scale(self, factor: i64) -> Result<Beat, BeatError>

Exact scaling by a whole number (e.g. a 4-beat phrase repeated 3 times is phrase.scale(3)).

Source

pub fn to_f64(self) -> f64

The floating-point value, for the single crossing to frames at the scheduling boundary (and nowhere else — composition math stays exact).

Trait Implementations§

Source§

impl Clone for Beat

Source§

fn clone(&self) -> Beat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Beat

Source§

impl Debug for Beat

Source§

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

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

impl<'de> Deserialize<'de> for Beat

Deserializing routes through Beat::new so the normalization invariant holds no matter where the value came from.

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 Display for Beat

Source§

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

3/2, or the bare integer when the denominator is 1 (4, not 4/1).

Source§

impl Eq for Beat

Source§

impl From<(i64, u32)> for Beat

Source§

fn from((num, den): (i64, u32)) -> Beat

Converts to this type from the input type.
Source§

impl Hash for Beat

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 JsonSchema for Beat

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Ord for Beat

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Beat

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Beat

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Beat

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 StructuralPartialEq for Beat

Auto Trait Implementations§

§

impl Freeze for Beat

§

impl RefUnwindSafe for Beat

§

impl Send for Beat

§

impl Sync for Beat

§

impl Unpin for Beat

§

impl UnsafeUnpin for Beat

§

impl UnwindSafe for Beat

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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