Struct libosu::TimingPoint

pub struct TimingPoint {
    pub time: TimeLocation,
    pub kiai: bool,
    pub sample_set: SampleSet,
    pub sample_index: u32,
    pub volume: u16,
    pub kind: TimingPointKind,
}

A timing point, which represents configuration settings for a timing section.

This is a generic timing point struct representing both inherited and uninherited timing points, distinguished by the kind field.

Fields

time: TimeLocation

The timestamp of this timing point, represented as a TimeLocation.

kiai: bool

Whether or not Kiai time should be on for this timing point.

sample_set: SampleSet

The sample set associated with this timing section.

sample_index: u32

Index (if using a custom sample)

volume: u16

Volume of this timing section.

kind: TimingPointKind

The type of this timing point. See TimingPointKind.

Implementations

impl TimingPoint

pub fn from_osz(
    input: impl AsRef<str>,
    parent: &Option<TimingPoint>
) -> Result<TimingPoint, Error>

Creates a TimingPoint from the *.osz format

pub fn as_osz(&self) -> Result<String, Error>

Serializes this TimingPoint into the *.osz format.

Trait Implementations

impl Clone for TimingPoint

pub fn clone(&self) -> TimingPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimingPoint

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

Formats the value using the given formatter.

impl Eq for TimingPoint

impl Ord for TimingPoint

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TimingPoint> for TimingPoint

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<TimingPoint> for TimingPoint

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Serialize for TimingPoint

pub fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.