Struct osu_file_parser::osu_file::timingpoints::TimingPoint

pub struct TimingPoint { /* private fields */ }

Struct representing a timing point. Each timing point influences a specified portion of the map, commonly called a timing section. The .osu file format requires these to be sorted in chronological order.

Implementations

impl TimingPoint

pub fn beat_duration_ms_to_bpm(beat_duration_ms: Decimal) -> Decimal

Converts beat duration in milliseconds to BPM.

pub fn bpm_to_beat_duration_ms(bpm: Decimal) -> Decimal

Converts BPM to beat duration in milliseconds.

pub fn new_inherited(
    time: Integer,
    slider_velocity_multiplier: Decimal,
    meter: Integer,
    sample_set: SampleSet,
    sample_index: SampleIndex,
    volume: Volume,
    effects: Effects
) -> Self

New instance of TimingPoint that is inherited.

pub fn new_uninherited(
    time: Integer,
    beat_duration_ms: Decimal,
    meter: Integer,
    sample_set: SampleSet,
    sample_index: SampleIndex,
    volume: Volume,
    effects: Effects
) -> Self

New instance of TimingPoint that is uninherited.

pub fn calc_bpm(&self) -> Option<Decimal>

Calculates BPM using the beatLength field when unherited.

• Returns None if the timing point is inherited or beat_length isn’t a valid decimal.

pub fn calc_slider_velocity_multiplier(&self) -> Option<Decimal>

Calculates the slider velocity multiplier when the timing point is inherited.

• Returns None if the timing point is uninherited or beat_length isn’t a valid decimal.

pub fn time(&self) -> &Decimal

Start time of the timing section, in milliseconds from the beginning of the beatmap’s audio. The end of the timing section is the next timing point’s time (or never, if this is the last timing point).

pub fn set_time(&mut self, time: Integer)

Set the timing point’s start time.

pub fn meter(&self) -> i32

Amount of beats in a measure. Inherited timing points ignore this property.

pub fn set_meter(&mut self, meter: Integer)

Set the timing point’s meter field.

pub fn sample_set(&self) -> SampleSet

Default sample set for hit objects

pub fn set_sample_set(&mut self, sample_set: SampleSet)

Set the timing point’s sample set.

pub fn sample_index(&self) -> SampleIndex

Custom sample index for hit objects.

pub fn sample_index_mut(&mut self) -> &mut SampleIndex

Get a mutable reference to the timing point’s sample index.

pub fn volume(&self) -> &Volume

Volume percentage for hit objects.

pub fn set_volume(&mut self, volume: Volume)

Set the timing point’s volume.

pub fn uninherited(&self) -> bool

Get the timing point’s uninherited.

pub fn set_uninherited(&mut self, uninherited: bool)

Set the timing point’s uninherited.

pub fn effects(&self) -> Option<&Effects>

Get the timing point’s effects.

pub fn effects_mut(&mut self) -> &mut Option<Effects>

Get a mutable reference to the timing point’s effects.

Trait Implementations

impl Clone for TimingPoint

fn clone(&self) -> TimingPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimingPoint

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

Formats the value using the given formatter.

impl Hash for TimingPoint

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<TimingPoint> for TimingPoint

fn eq(&self, other: &TimingPoint) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VersionedFromStr for TimingPoint

type Err = ParseTimingPointError

fn from_str(s: &str, version: Version) -> Result<Option<Self>, Self::Err>

Parses a string into an object.

impl VersionedToString for TimingPoint

fn to_string(&self, version: Version) -> Option<String>

Returns a string representation of the object.

impl Eq for TimingPoint

impl StructuralEq for TimingPoint

impl StructuralPartialEq for TimingPoint