Struct oppai_rs::Mods

pub struct Mods { /* fields omitted */ }

The mods available to osu!

Methods

impl Mods

pub const NOMOD: Mods

pub const NF: Mods

pub const EZ: Mods

pub const TD: Mods

pub const HD: Mods

pub const HR: Mods

pub const SD: Mods

pub const DT: Mods

pub const RX: Mods

pub const HT: Mods

pub const NC: Mods

pub const FL: Mods

pub const AT: Mods

pub const SO: Mods

pub const AP: Mods

pub const PF: Mods

pub const KEY4: Mods

pub const KEY5: Mods

pub const KEY6: Mods

pub const KEY7: Mods

pub const KEY8: Mods

pub const FADEIN: Mods

pub const RANDOM: Mods

pub const CINEMA: Mods

pub const TARGET: Mods

pub const KEY9: Mods

pub const KEYCOOP: Mods

pub const KEY1: Mods

pub const KEY3: Mods

pub const KEY2: Mods

pub const SCOREV2: Mods

pub const TOUCH_DEVICE: Mods

pub const NOVIDEO: Mods

pub const SPEED_CHANGING: Mods

pub const MAP_CHANGING: Mods

pub const fn empty() -> Mods

Returns an empty set of flags

pub const fn all() -> Mods

Returns the set containing all flags.

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_int) -> Option<Mods>

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

pub const fn from_bits_truncate(bits: c_int) -> Mods

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

pub const unsafe fn from_bits_unchecked(bits: c_int) -> Mods

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: Mods) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Mods

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

Formats the value using the given formatter.

impl BitAnd<Mods> for Mods

type Output = Mods

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Mods> for Mods

fn bitand_assign(&mut self, other: Mods)

Disables all flags disabled in the set.

impl BitOr<Mods> for Mods

type Output = Mods

The resulting type after applying the | operator.

fn bitor(self, other: Mods) -> Mods

Returns the union of the two sets of flags.

impl BitOrAssign<Mods> for Mods

fn bitor_assign(&mut self, other: Mods)

Adds the set of flags.

impl BitXor<Mods> for Mods

type Output = Mods

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Mods> for Mods

fn bitxor_assign(&mut self, other: Mods)

Toggles the set of flags.

impl Clone for Mods

fn clone(&self) -> Mods

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mods

impl Debug for Mods

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

Formats the value using the given formatter.

impl Default for Mods

fn default() -> Mods

Returns the "default value" for a type.

impl Eq for Mods

impl Extend<Mods> for Mods

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

Extends a collection with the contents of an iterator.

impl FromIterator<Mods> for Mods

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

Creates a value from an iterator.

impl Hash for Mods

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for Mods

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

Formats the value using the given formatter.

impl Not for Mods

type Output = Mods

The resulting type after applying the ! operator.

fn not(self) -> Mods

Returns the complement of this set of flags.

impl Octal for Mods

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

Formats the value using the given formatter.

impl Ord for Mods

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<Mods> for Mods

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

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

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

This method tests for !=.

impl PartialOrd<Mods> for Mods

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Mods

impl StructuralPartialEq for Mods

impl Sub<Mods> for Mods

type Output = Mods

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Mods> for Mods

fn sub_assign(&mut self, other: Mods)

Disables all flags enabled in the set.

impl UpperHex for Mods

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

Formats the value using the given formatter.