Enum libosu::TimeLocation

pub enum TimeLocation {
    Absolute(AbsoluteTime),
    Relative(RelativeTime),
}

A struct representing a precise location in time.

This enum represents a timestamp by either an absolute timestamp (milliseconds), or a tuple (t, m, f) where t is the TimingPoint that it's relative to, m is the measure number from within this timing section, and f is a fraction (actually implemented with num_rational::Ratio) that represents how far into the measure this note appears.

When possible, prefer to stack measures. The value of f should not ever reach 1; instead, opt to use measure numbers for whole amounts of measures. For example, 1 measure + 5 / 4 should be represented as 2 measures + 1 / 4 instead.

Variants

Absolute(AbsoluteTime)

Absolute timing in terms of number of milliseconds since the beginning of the audio file. Note that because this is an i32, the time is allowed to be negative.

Relative(RelativeTime)

Relative timing based on an existing TimingPoint. The lifetime of this TimeLocation thus depends on the lifetime of the map.

Methods

impl TimeLocation

pub fn into_absolute(self) -> TimeLocation

Converts any TimeLocation into an absolute one.

pub fn as_milliseconds(&self) -> i32

Converts any TimeLocation into an absolute time in milliseconds from the beginning of the audio file.

pub fn into_relative(self, tp: &TimingPoint) -> TimeLocation

Converts any TimeLocation into a relative one.

pub fn approximate(     &self,     time: &TimeLocation,     bpm: f64,     meter: u32 ) -> (u32, Ratio<u32>)

Converts any TimeLocation into a relative time tuple given a TimingPoint.

Trait Implementations

impl Clone for TimeLocation

fn clone(&self) -> TimeLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeLocation

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

Formats the value using the given formatter.

impl Eq for TimeLocation

impl PartialEq for TimeLocation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Ord for TimeLocation

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialOrd for TimeLocation

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Into<TimeLocation> for i32

fn into(self) -> TimeLocation

Performs the conversion.

impl<'a> Into<TimeLocation> for &'a TimeLocation

fn into(self) -> TimeLocation

Performs the conversion.