Struct rosu::model::GameMods

pub struct GameMods { /* fields omitted */ }

Enum for all game modifications. Implemented as bitflags.

Example

use rosu::model::GameMods;
use std::str::FromStr;

let nomod = GameMods::default();
assert_eq!(nomod, GameMods::NoMod);

// Bitwise creating, or from u32
let hdhr_1 = GameMods::HardRock | GameMods::Hidden;
let hdhr_2 = GameMods::from_bits(8 + 16).unwrap();
assert_eq!(hdhr_1, hdhr_2);

// contains, intersects, and a few more methods from bitflags
let ezhdpf = GameMods::Easy | GameMods::Hidden | GameMods::Perfect;
assert!(!ezhdpf.contains(GameMods::HardRock));
let hdpf = GameMods::Hidden | GameMods::Perfect;
assert!(ezhdpf.intersects(hdpf));

// Try converting from &str
let hdhrdt = GameMods::from_str("dthdhr").unwrap();
assert_eq!(hdhrdt.bits(), 8 + 16 + 64);
// Implements fmt::Display
assert_eq!(hdhrdt.to_string(), "HDHRDT".to_string());

// Iterator
let mut mod_iter = GameMods::from_bits(536871512).unwrap().iter();
assert_eq!(mod_iter.next(), Some(GameMods::Hidden));
assert_eq!(mod_iter.next(), Some(GameMods::HardRock));
assert_eq!(mod_iter.next(), Some(GameMods::NightCore));
assert_eq!(mod_iter.next(), Some(GameMods::ScoreV2));
assert_eq!(mod_iter.next(), None);

Implementations

impl GameMods

pub const NoMod: GameMods

pub const NoFail: GameMods

pub const Easy: GameMods

pub const TouchDevice: GameMods

pub const Hidden: GameMods

pub const HardRock: GameMods

pub const SuddenDeath: GameMods

pub const DoubleTime: GameMods

pub const Relax: GameMods

pub const HalfTime: GameMods

pub const NightCore: GameMods

pub const Flashlight: GameMods

pub const SpunOut: GameMods

pub const Perfect: GameMods

pub const FadeIn: GameMods

pub const ScoreV2: GameMods

pub const Mirror: GameMods

pub const Key1: GameMods

pub const Key2: GameMods

pub const Key3: GameMods

pub const Key4: GameMods

pub const Key5: GameMods

pub const Key6: GameMods

pub const Key7: GameMods

pub const Key8: GameMods

pub const Key9: GameMods

pub const KeyCoop: GameMods

pub const Autoplay: GameMods

pub const Autopilot: GameMods

pub const Cinema: GameMods

pub const Random: GameMods

pub const Target: GameMods

pub const fn empty() -> GameMods

Returns an empty set of flags

pub const fn all() -> GameMods

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<GameMods>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> GameMods

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> GameMods

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: GameMods) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: GameMods) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: GameMods)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: GameMods)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: GameMods)

Toggles the specified flags in-place.

pub fn set(&mut self, other: GameMods, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl GameMods

pub fn has_key_mod(self) -> Option<GameMods>

Method that checks whether GameMods contains one of osu!mania's key mods.

Examples

use rosu::model::GameMods;

let mods = GameMods::Hidden | GameMods::Key4;
assert_eq!(mods.has_key_mod(), Some(GameMods::Key4));
assert_eq!(GameMods::Hidden.has_key_mod(), None);

pub fn score_multiplier(self, mode: GameMode) -> f32

Calculate the multiplier of the mods which will influence a Score's playscore

Example

use rosu::model::{GameMods, GameMode};

let ezhd = GameMods::from_bits(2 + 8).unwrap();
assert_eq!(ezhd.score_multiplier(GameMode::STD), 0.53);
assert_eq!(ezhd.score_multiplier(GameMode::MNA), 0.5);

pub fn increases_score(self, mode: GameMode) -> bool

Check if a Score's playscore will be increased

Example

use rosu::model::{GameMods, GameMode};

let hrso = GameMods::HardRock | GameMods::SpunOut;
assert!(!hrso.increases_score(GameMode::STD));
assert!(GameMods::DoubleTime.increases_score(GameMode::TKO));

pub fn decreases_score(self, mode: GameMode) -> bool

Check if a Score's playscore will be decreased

Example

use rosu::model::{GameMods, GameMode};

let hrso = GameMods::HardRock | GameMods::SpunOut;
assert!(hrso.decreases_score(GameMode::STD));
assert!(!GameMods::DoubleTime.decreases_score(GameMode::TKO));

pub fn changes_stars(self, mode: GameMode) -> bool

Check if a Beatmap's star rating for the given GameMode will be influenced.

Example

use rosu::model::{GameMode, GameMods};

let hdhr = GameMods::Hidden | GameMods::HardRock;
assert!(hdhr.changes_stars(GameMode::STD));
assert!(!hdhr.changes_stars(GameMode::MNA));
let nc = GameMods::NightCore;
assert!(nc.changes_stars(GameMode::MNA));

pub fn iter(self) -> IntoIter

Returns an iterator. Alias of into_iter.

Example

use rosu::model::GameMods;

let mods = GameMods::from_bits(8 + 16 + 64 + 128).unwrap();
let mut mod_iter = mods.iter();
assert_eq!(mod_iter.next(), Some(GameMods::Hidden));
assert_eq!(mod_iter.next(), Some(GameMods::HardRock));
assert_eq!(mod_iter.next(), Some(GameMods::DoubleTime));
assert_eq!(mod_iter.next(), Some(GameMods::Relax));
assert_eq!(mod_iter.next(), None);

pub fn len(self) -> usize

Returns the amount of contained mods.

Example

use rosu::model::GameMods;

assert_eq!(GameMods::NoMod.len(), 0);
let mods = GameMods::from_bits(8 + 16 + 64 + 128).unwrap();
assert_eq!(mods.len(), 4);

Trait Implementations

impl Binary for GameMods

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

Formats the value using the given formatter.

impl BitAnd<GameMods> for GameMods

type Output = GameMods

The resulting type after applying the & operator.

pub fn bitand(self, other: GameMods) -> GameMods

Returns the intersection between the two sets of flags.

impl BitAndAssign<GameMods> for GameMods

pub fn bitand_assign(&mut self, other: GameMods)

Disables all flags disabled in the set.

impl BitOr<GameMods> for GameMods

type Output = GameMods

The resulting type after applying the | operator.

pub fn bitor(self, other: GameMods) -> GameMods

Returns the union of the two sets of flags.

impl BitOrAssign<GameMods> for GameMods

pub fn bitor_assign(&mut self, other: GameMods)

Adds the set of flags.

impl BitXor<GameMods> for GameMods

type Output = GameMods

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: GameMods) -> GameMods

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<GameMods> for GameMods

pub fn bitxor_assign(&mut self, other: GameMods)

Toggles the set of flags.

impl Clone for GameMods

pub fn clone(&self) -> GameMods

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for GameMods

impl Debug for GameMods

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

Formats the value using the given formatter.

impl Default for GameMods

pub fn default() -> GameMods

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for GameMods

pub fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for GameMods

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

Formats the value using the given formatter.

impl Eq for GameMods

impl Extend<GameMods> for GameMods

pub fn extend<T: IntoIterator<Item = GameMods>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<GameMods> for GameMods

pub fn from_iter<T: IntoIterator<Item = GameMods>>(iterator: T) -> GameMods

Creates a value from an iterator.

impl FromStr for GameMods

type Err = OsuError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for GameMods

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Into<u32> for GameMods

pub fn into(self) -> u32

Performs the conversion.

impl IntoIterator for GameMods

type Item = GameMods

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl LowerHex for GameMods

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

Formats the value using the given formatter.

impl Not for GameMods

type Output = GameMods

The resulting type after applying the ! operator.

pub fn not(self) -> GameMods

Returns the complement of this set of flags.

impl Octal for GameMods

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

Formats the value using the given formatter.

impl Ord for GameMods

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

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

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

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

This method tests for !=.

impl PartialOrd<GameMods> for GameMods

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

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

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

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

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

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

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

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

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

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

impl Serialize for GameMods

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

Serialize this value into the given Serde serializer.

impl StructuralEq for GameMods

impl StructuralPartialEq for GameMods

impl Sub<GameMods> for GameMods

type Output = GameMods

The resulting type after applying the - operator.

pub fn sub(self, other: GameMods) -> GameMods

Returns the set difference of the two sets of flags.

impl SubAssign<GameMods> for GameMods

pub fn sub_assign(&mut self, other: GameMods)

Disables all flags enabled in the set.

impl TryFrom<u32> for GameMods

type Error = OsuError

The type returned in the event of a conversion error.

pub fn try_from(m: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for GameMods

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

Formats the value using the given formatter.