Struct Ticks

pub struct Ticks(pub Ticks);

Time representation in the form of Ticks.

Tuple Fields

0: Ticks

Implementations

impl Ticks

pub fn ticks(&self) -> Ticks

Return the unit value of Ticks.

pub fn bars(&self, ts: TimeSig, ppqn: Ppqn) -> f64

Convert to the equivalent duration as a number of Bars.

pub fn beats(&self, ppqn: Ppqn) -> f64

Convert to the equivalent duration as a number of Beats.

Examples found in repository

examples/test.rs (line 38)

fn main() {
    println!("time_calc demonstration!");

    // Out `Bars` type is a simplified version of a Measure.
    assert!(Bars(1).measure() == Measure(1, Division::Bar, DivType::Whole));
    // The same goes for out `Beats` type.
    assert!(Beats(1).measure() == Measure(1, Division::Beat, DivType::Whole));

    // We can use "parts per quarter note" to convert to ticks.
    println!("Parts per quarter note: {}", PPQN);
    println!("Duration of a beat in ticks: {}", Beats(1).ticks(PPQN));
    println!("Duration of 38_400 ticks in beats: {}", Ticks(38_400).beats(PPQN));

    // We can use "beats per minute" to convert from musical time to milliseconds.
    let bpm: Bpm = 120.0;
    println!("Duration of a beat at 120 beats per minute: {} milliseconds.", Beats(1).ms(bpm));

    // And we can use "samples per second" to convert our duration to samples.
    println!("Samples per second: {}", SAMPLE_HZ);
    println!("Duration of a beat at 120bpm in samples: {}", Beats(1).samples(bpm, SAMPLE_HZ));

    // We also need to know the "time signature" if we are to convert from "Bars".
    // This is because different time signatures can have a different duration in "Beats".
    let beats_per_bar = TimeSig { top: 4, bottom: 4 }.beats_per_bar();
    println!("Duration of a bar in `Beats` with a 4/4 Time Signature: {}", beats_per_bar);
    let beats_per_bar = TimeSig { top: 3, bottom: 4 }.beats_per_bar();
    println!("Duration of a bar in `Beats` with a 3/4 Time Signature: {}", beats_per_bar);
    let beats_per_bar = TimeSig { top: 7, bottom: 8 }.beats_per_bar();
    println!("Duration of a bar in `Beats` with a 7/8 Time Signature: {}", beats_per_bar);
    let time_sig = TimeSig { top: 4, bottom: 4 };
    println!("Duration of a bar at 120bpm, 44_100 sample_hz and 4/4 Time Sig in samples: {}",
             Bars(1).samples(bpm, time_sig, SAMPLE_HZ));

    // We can also convert back the other way! Here's an example from Ms -> Beats.
    println!("1 minute as a duration in beats: {}", Ms(60_000.0).beats(bpm));

    // Here's an example from Samples -> Bars.
    println!("176_400 samples as a duration in bars: {}",
             Samples(176_400).bars(bpm, time_sig, SAMPLE_HZ));

    println!("Great Success!");
}

pub fn ms(&self, bpm: Bpm, ppqn: Ppqn) -> Ms

Convert to the unit value of Ms.

pub fn to_ms(&self, bpm: Bpm, ppqn: Ppqn) -> Ms

Convert to Ms.

pub fn samples(&self, bpm: Bpm, ppqn: Ppqn, sample_hz: SampleHz) -> Samples

Convert to the unit value of Samples.

pub fn to_samples(&self, bpm: Bpm, ppqn: Ppqn, sample_hz: SampleHz) -> Samples

Convert to Samples.

Trait Implementations

impl Add for Ticks

type Output = Ticks

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Ticks

Performs the + operation.

impl AddAssign for Ticks

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Ticks

fn clone(&self) -> Ticks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ticks

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

Formats the value using the given formatter.

impl Div for Ticks

type Output = Ticks

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Ticks

Performs the / operation.

impl DivAssign for Ticks

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<i64> for Ticks

fn from(ticks: Ticks) -> Self

Converts to this type from the input type.

impl FromPrimitive for Ticks

fn from_u64(n: u64) -> Option<Ticks>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i64(n: i64) -> Option<Ticks>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for Ticks

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 Mul for Ticks

type Output = Ticks

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Ticks

Performs the * operation.

impl MulAssign for Ticks

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Ticks

type Output = Ticks

The resulting type after applying the - operator.

fn neg(self) -> Ticks

Performs the unary - operation.

impl Ord for Ticks

fn cmp(&self, other: &Ticks) -> 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 Ticks

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

fn partial_cmp(&self, other: &Ticks) -> 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 Rem for Ticks

type Output = Ticks

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Ticks

Performs the % operation.

impl RemAssign for Ticks

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub for Ticks

type Output = Ticks

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Ticks

Performs the - operation.

impl SubAssign for Ticks

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl ToPrimitive for Ticks

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl Copy for Ticks

impl Eq for Ticks

impl StructuralPartialEq for Ticks