Struct rosu_v2::model::GameMods

source ·

pub struct GameMods { /* private fields */ }

Expand description

Enum for all game modifications. Implemented as bitflags.

Example

use rosu_v2::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§

source §

pub const fn empty() -> Self

Returns an empty set of flags.

source

pub const fn all() -> Self

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

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

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

source

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

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

source

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

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

source

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

Removes the specified flags in-place.

source

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

Toggles the specified flags in-place.

source

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

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

source

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

source

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

source

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

source

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

source

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

source §

impl GameMods

source

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

Method that checks whether the GameMods contain one of osu!mania’s key mods.

Examples

use rosu_v2::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);

source

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

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

Example

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

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

source

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

Check if a Score’s playscore will be increased

Example

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

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

source

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

Check if a Score’s playscore will be decreased

Example

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

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

source

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_v2::model::{GameMode, GameMods};

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

source

pub fn iter(self) -> GameModsIter

Returns an iterator. Alias of into_iter.

Example

use rosu_v2::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);

source

pub fn len(self) -> usize

Returns the amount of contained mods.

Example

use rosu_v2::model::GameMods;

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