Struct rosu_mods::GameModsLegacy

pub struct GameModsLegacy(/* private fields */);

Lightweight bitflag type for legacy mods.

Example

use rosu_mods::GameModsLegacy;

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

// Created via bit operations or from a u32
let hdhr_1 = GameModsLegacy::Hidden | GameModsLegacy::HardRock;
let hdhr_2 = GameModsLegacy::from_bits(8 + 16);
assert_eq!(hdhr_1, hdhr_2);

// Various methods for convenience like `contains` and `intersects`.
let ezhdpf = GameModsLegacy::Easy | GameModsLegacy::Hidden | GameModsLegacy::Perfect;
assert!(!ezhdpf.contains(GameModsLegacy::HardRock));
let hdpf = GameModsLegacy::Hidden | GameModsLegacy::Perfect;
assert!(ezhdpf.intersects(hdpf));

// Parsing a `&str`
let hdhrdt = "dthdhr".parse::<GameModsLegacy>().unwrap();
assert_eq!(hdhrdt.bits(), 8 + 16 + 64);

// The Display implementation combines all acronyms
assert_eq!(hdhrdt.to_string(), "HDHRDT".to_string());

// Has an iterator type
let mut iter = GameModsLegacy::from_bits(536871512).iter();
assert_eq!(iter.next(), Some(GameModsLegacy::Hidden));
assert_eq!(iter.next(), Some(GameModsLegacy::HardRock));
assert_eq!(iter.next(), Some(GameModsLegacy::Nightcore));
assert_eq!(iter.next(), Some(GameModsLegacy::ScoreV2));
assert_eq!(iter.next(), None);

Implementations

impl GameModsLegacy

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 Autoplay: Self = _

pub const SpunOut: Self = _

pub const Autopilot: Self = _

pub const Perfect: Self = _

pub const Key4: Self = _

pub const Key5: Self = _

pub const Key6: Self = _

pub const Key7: Self = _

pub const Key8: Self = _

pub const FadeIn: Self = _

pub const Random: Self = _

pub const Cinema: Self = _

pub const Target: Self = _

pub const Key9: Self = _

pub const KeyCoop: Self = _

pub const Key1: Self = _

pub const Key3: Self = _

pub const Key2: Self = _

pub const ScoreV2: Self = _

pub const Mirror: Self = _

impl GameModsLegacy

pub const fn clock_rate(self) -> f32

Returns the clock rate for the mods i.e. 1.5 for DT, 0.75 for HT, and 1.0 otherwise.

pub const fn len(self) -> usize

Returns the amount of contained mods.

Example

use rosu_mods::GameModsLegacy;

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

pub fn iter(self) -> GameModsLegacyIter

Returns an iterator over GameModsLegacy.

Example

use rosu_mods::GameModsLegacy;

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

let mut iter = GameModsLegacy::NoMod.iter();
assert_eq!(iter.next(), Some(GameModsLegacy::NoMod));
assert_eq!(iter.next(), None);

pub fn to_intermode(self) -> GameModsIntermode

Convert GameModsLegacy to GameModsIntermode.

impl GameModsLegacy

pub const fn bits(self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

Unknown bits are retained.

pub const fn is_empty(self) -> bool

Whether all bits in this flags value are unset.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

Trait Implementations

impl Archive for GameModsLegacy

Available on crate feature rkyv only.

type Archived = GameModsLegacy

The archived representation of this type.

type Resolver = ()

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve(&self, pos: usize, resolver: (), out: *mut Self)

Creates the archived version of this value at the given position and writes it to the given output.

impl Binary for GameModsLegacy

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

Formats the value using the given formatter.

impl BitAnd for GameModsLegacy

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = GameModsLegacy

The resulting type after applying the & operator.

impl BitAndAssign for GameModsLegacy

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for GameModsLegacy

fn bitor(self, other: GameModsLegacy) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = GameModsLegacy

The resulting type after applying the | operator.

impl BitOrAssign for GameModsLegacy

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for GameModsLegacy

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = GameModsLegacy

The resulting type after applying the ^ operator.

impl<C: ?Sized> CheckBytes<C> for GameModsLegacy

Available on crate feature rkyv only.

type Error = TupleStructCheckError

The error that may result from checking the type.

unsafe fn check_bytes<'a>( value: *const Self, ctx: &mut C, ) -> Result<&'a Self, TupleStructCheckError>

Checks whether the given pointer points to a valid value within the given context.

impl Clone for GameModsLegacy

fn clone(&self) -> GameModsLegacy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameModsLegacy

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

Formats the value using the given formatter.

impl Default for GameModsLegacy

fn default() -> GameModsLegacy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GameModsLegacy

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl<D: Fallible + ?Sized> Deserialize<GameModsLegacy, D> for GameModsLegacy

Available on crate feature rkyv only.

fn deserialize(&self, _: &mut D) -> Result<Self, D::Error>

Deserializes using the given deserializer

impl Display for GameModsLegacy

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

Formats the value using the given formatter.

impl Extend<GameModsLegacy> for GameModsLegacy

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

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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 From<GameModsLegacy> for GameModsIntermode

fn from(mods: GameModsLegacy) -> Self

Converts to this type from the input type.

impl From<GameModsLegacy> for u32

fn from(mods: GameModsLegacy) -> Self

Converts to this type from the input type.

impl FromIterator<GameModsLegacy> for GameModsLegacy

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

The bitwise or (|) of the bits in each flags value.

impl FromStr for GameModsLegacy

type Err = GameModsLegacyParseError

The associated error which can be returned from parsing.

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

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

impl Hash for GameModsLegacy

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for GameModsLegacy

type Item = GameModsLegacy

The type of the elements being iterated over.

type IntoIter = GameModsLegacyIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for GameModsLegacy

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for GameModsLegacy

fn eq(&self, other: &GameModsLegacy) -> 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 PartialOrd for GameModsLegacy

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

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

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

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

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

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

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

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

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<S: Fallible + ?Sized> Serialize<S> for GameModsLegacy

Available on crate feature rkyv only.

fn serialize(&self, s: &mut S) -> Result<(), S::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for GameModsLegacy

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl Sub for GameModsLegacy

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = GameModsLegacy

The resulting type after applying the - operator.

impl SubAssign for GameModsLegacy

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl TryFrom<Acronym> for GameModsLegacy

type Error = GameModsLegacyParseError

The type returned in the event of a conversion error.

fn try_from(acronym: Acronym) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for GameModsLegacy

impl Eq for GameModsLegacy

impl StructuralPartialEq for GameModsLegacy