Struct TickTime 

pub struct TickTime {
    pub ticks: i64,
    pub tpq: u32,
}

A point in musical time measured in ticks at a given resolution.

ticks counts the offset and tpq is the ticks-per-quarter-note resolution, so the same instant can be represented at different resolutions. Helpers convert between resolutions via rebase (exact) and quantize (rounding).

Fields

ticks: i64

Tick offset, interpreted at this value’s tpq resolution.

tpq: u32

Resolution in ticks per quarter note; must be non-zero.

Implementations

impl TickTime

pub const ZERO: Self

The origin: zero ticks at unit resolution.

pub fn new(ticks: i64, tpq: u32) -> Result<Self, MidiError>

Creates a time at tpq resolution, failing with MidiError::ZeroTpq when tpq is zero.

pub fn from_quarters(quarters: i64) -> Self

Builds a time of whole quarter notes at unit resolution (tpq == 1).

pub fn mul_int(self, factor: i64) -> Self

Scales the tick count by an integer factor, keeping the resolution.

pub fn mul_ratio( self, numerator: i64, denominator: i64, ) -> Result<Self, MidiError>

Scales the tick count by numerator / denominator, failing with MidiError::InvalidRatio when denominator is zero.

pub fn div_ratio( self, numerator: i64, denominator: i64, ) -> Result<Self, MidiError>

Scales the tick count by denominator / numerator, failing with MidiError::InvalidRatio when numerator is zero.

pub fn rebase(self, new_tpq: u32) -> Result<Self, MidiError>

Re-expresses this time at new_tpq resolution without rounding.

Fails with MidiError::ZeroTpq when new_tpq is zero, or MidiError::InexactRebase when the conversion would not be exact.

pub fn quantize(self, new_tpq: u32) -> Self

Re-expresses this time at new_tpq resolution, rounding to the nearest tick. A zero new_tpq is clamped to unit resolution.

pub fn as_rational(self) -> (i64, i64)

Returns the time as a (ticks, tpq) rational in quarter notes.

pub fn as_f64_quarters(self) -> f64

Returns the time as a floating-point count of quarter notes.

Trait Implementations

impl Add for TickTime

type Output = TickTime

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl Clone for TickTime

fn clone(&self) -> TickTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TickTime

impl Debug for TickTime

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

Formats the value using the given formatter.

impl Eq for TickTime

impl Hash for TickTime

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 Ord for TickTime

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TickTime

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for TickTime

impl Sub for TickTime

type Output = TickTime

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.