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
sourceimpl GameMods
impl GameMods
pub const NoMod: Self
pub const NoFail: Self
pub const Easy: Self
pub const TouchDevice: Self
pub const Hidden: Self
pub const HardRock: Self
pub const SuddenDeath: Self
pub const DoubleTime: Self
pub const Relax: Self
pub const HalfTime: Self
pub const NightCore: Self
pub const Flashlight: Self
pub const SpunOut: Self
pub const Perfect: Self
pub const FadeIn: Self
pub const ScoreV2: Self
pub const Mirror: Self
pub const Key1: Self
pub const Key2: Self
pub const Key3: Self
pub const Key4: Self
pub const Key5: Self
pub const Key6: Self
pub const Key7: Self
pub const Key8: Self
pub const Key9: Self
pub const KeyCoop: Self
pub const Autoplay: Self
pub const Autopilot: Self
pub const Cinema: Self
pub const Random: Self
pub const Target: Self
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
.
sourceimpl GameMods
impl GameMods
sourcepub fn has_key_mod(self) -> Option<GameMods>
pub fn has_key_mod(self) -> Option<GameMods>
sourcepub fn score_multiplier(self, mode: GameMode) -> f32
pub fn score_multiplier(self, mode: GameMode) -> f32
sourcepub fn increases_score(self, mode: GameMode) -> bool
pub fn increases_score(self, mode: GameMode) -> bool
sourcepub fn decreases_score(self, mode: GameMode) -> bool
pub fn decreases_score(self, mode: GameMode) -> bool
sourcepub fn changes_stars(self, mode: GameMode) -> bool
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::STD));
assert!(!hdhr.changes_stars(GameMode::MNA));
let nc = GameMods::NightCore;
assert!(nc.changes_stars(GameMode::MNA));
sourcepub fn iter(self) -> GameModsIter
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);
Trait Implementations
sourceimpl BitAndAssign<GameMods> for GameMods
impl BitAndAssign<GameMods> for GameMods
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOrAssign<GameMods> for GameMods
impl BitOrAssign<GameMods> for GameMods
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXorAssign<GameMods> for GameMods
impl BitXorAssign<GameMods> for GameMods
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl<'de> Deserialize<'de> for GameMods
impl<'de> Deserialize<'de> for GameMods
sourcefn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Extend<GameMods> for GameMods
impl Extend<GameMods> for GameMods
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<GameMods> for GameMods
impl FromIterator<GameMods> for GameMods
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl IntoIterator for GameMods
impl IntoIterator for GameMods
sourceimpl Ord for GameMods
impl Ord for GameMods
sourceimpl PartialOrd<GameMods> for GameMods
impl PartialOrd<GameMods> for GameMods
sourcefn partial_cmp(&self, other: &GameMods) -> Option<Ordering>
fn partial_cmp(&self, other: &GameMods) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl SubAssign<GameMods> for GameMods
impl SubAssign<GameMods> for GameMods
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
impl Copy for GameMods
impl Eq for GameMods
impl StructuralEq for GameMods
impl StructuralPartialEq for GameMods
Auto Trait Implementations
impl RefUnwindSafe for GameMods
impl Send for GameMods
impl Sync for GameMods
impl Unpin for GameMods
impl UnwindSafe for GameMods
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcepub fn equivalent(&self, key: &K) -> bool
pub fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more