Struct rosu_pp::osu::OsuPerformance

pub struct OsuPerformance<'map> { /* private fields */ }

Performance calculator on osu!standard maps.

Implementations

impl<'map> OsuPerformance<'map>

pub fn new(map_or_attrs: impl IntoModePerformance<'map, Osu>) -> Self

Create a new performance calculator for osu! maps.

The argument map_or_attrs must be either

• previously calculated attributes (OsuDifficultyAttributes or OsuPerformanceAttributes)
• a beatmap (OsuBeatmap<'map>)

If a map is given, difficulty attributes will need to be calculated internally which is a costly operation. Hence, passing attributes should be prefered.

However, when passing previously calculated attributes, make sure they have been calculated for the same map and Difficulty settings. Otherwise, the final attributes will be incorrect.

pub fn try_new(map_or_attrs: impl IntoPerformance<'map>) -> Option<Self>

Try to create a new performance calculator for osu! maps.

Returns None if map_or_attrs does not belong to osu! e.g. a Converted, DifficultyAttributes, or PerformanceAttributes of a different mode.

See OsuPerformance::new for more information.

pub fn try_mode(self, mode: GameMode) -> Result<Performance<'map>, Self>

Attempt to convert the map to the specified mode.

Returns Err(self) if no beatmap is contained, i.e. if this OsuPerformance was created through attributes or OsuPerformance::generate_state was called.

If the given mode should be ignored in case of an error, use mode_or_ignore instead.

pub fn mode_or_ignore(self, mode: GameMode) -> Performance<'map>

Attempt to convert the map to the specified mode.

If the internal beatmap was already replaced with difficulty attributes, the map won’t be modified.

To see whether the internal beatmap was replaced, use try_mode instead.

pub const fn mods(self, mods: u32) -> Self

Specify mods through their bit values.

See https://github.com/ppy/osu-api/wiki#mods

pub const fn combo(self, combo: u32) -> Self

Specify the max combo of the play.

pub const fn hitresult_priority(self, priority: HitResultPriority) -> Self

Specify how hitresults should be generated.

Defauls to HitResultPriority::BestCase.

pub const fn n300(self, n300: u32) -> Self

Specify the amount of 300s of a play.

pub const fn n100(self, n100: u32) -> Self

Specify the amount of 100s of a play.

pub const fn n50(self, n50: u32) -> Self

Specify the amount of 50s of a play.

pub const fn misses(self, n_misses: u32) -> Self

Specify the amount of misses of a play.

pub const fn difficulty(self, difficulty: Difficulty) -> Self

Use the specified settings of the given Difficulty.

pub const fn passed_objects(self, passed_objects: u32) -> Self

Amount of passed objects for partial plays, e.g. a fail.

If you want to calculate the performance after every few objects, instead of using OsuPerformance multiple times with different passed_objects, you should use OsuGradualPerformance.

pub fn clock_rate(self, clock_rate: f64) -> Self

Adjust the clock rate used in the calculation.

If none is specified, it will take the clock rate based on the mods i.e. 1.5 for DT, 0.75 for HT and 1.0 otherwise.

Minimum	Maximum
0.01	100

pub fn ar(self, ar: f32, with_mods: bool) -> Self

Override a beatmap’s set AR.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub fn cs(self, cs: f32, with_mods: bool) -> Self

Override a beatmap’s set CS.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub fn hp(self, hp: f32, with_mods: bool) -> Self

Override a beatmap’s set HP.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub fn od(self, od: f32, with_mods: bool) -> Self

Override a beatmap’s set OD.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub const fn state(self, state: OsuScoreState) -> Self

Provide parameters through an OsuScoreState.

pub fn accuracy(self, acc: f64) -> Self

Specify the accuracy of a play between 0.0 and 100.0. This will be used to generate matching hitresults.

pub fn generate_state(&mut self) -> OsuScoreState

Create the OsuScoreState that will be used for performance calculation.

pub fn calculate(self) -> OsuPerformanceAttributes

Calculate all performance related values, including pp and stars.

Trait Implementations

impl<'map> Clone for OsuPerformance<'map>

fn clone(&self) -> OsuPerformance<'map>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'map> Debug for OsuPerformance<'map>

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

Formats the value using the given formatter.

impl<'map, T: IntoModePerformance<'map, Osu>> From<T> for OsuPerformance<'map>

fn from(into: T) -> Self

Converts to this type from the input type.

impl<'map> PartialEq for OsuPerformance<'map>

fn eq(&self, other: &OsuPerformance<'map>) -> 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<'map> TryFrom<OsuPerformance<'map>> for CatchPerformance<'map>

fn try_from(osu: OsuPerformance<'map>) -> Result<Self, Self::Error>

Try to create CatchPerformance through OsuPerformance.

Returns None if OsuPerformance does not contain a beatmap, i.e. if it was constructed through attributes or OsuPerformance::generate_state was called.

type Error = OsuPerformance<'map>

The type returned in the event of a conversion error.

impl<'map> TryFrom<OsuPerformance<'map>> for ManiaPerformance<'map>

fn try_from(osu: OsuPerformance<'map>) -> Result<Self, Self::Error>

Try to create ManiaPerformance through OsuPerformance.

Returns None if OsuPerformance does not contain a beatmap, i.e. if it was constructed through attributes or OsuPerformance::generate_state was called.

type Error = OsuPerformance<'map>

The type returned in the event of a conversion error.

impl<'map> TryFrom<OsuPerformance<'map>> for TaikoPerformance<'map>

fn try_from(osu: OsuPerformance<'map>) -> Result<Self, Self::Error>

Try to create TaikoPerformance through OsuPerformance.

Returns None if OsuPerformance does not contain a beatmap, i.e. if it was constructed through attributes or OsuPerformance::generate_state was called.

type Error = OsuPerformance<'map>

The type returned in the event of a conversion error.

impl<'map> StructuralPartialEq for OsuPerformance<'map>