Struct Acronym 

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

The acronym of a GameMod.

Implementations

impl Acronym

pub const unsafe fn from_str_unchecked(s: &str) -> Self

Create an Acronym from a string.

Safety

The given string must consist of two or three bytes representing capitalized ASCII letters or digits.

Example

use rosu_mods::Acronym;

let hd = unsafe { Acronym::from_str_unchecked("HD") };
assert_eq!(hd.as_str(), "HD");

Each of the following may lead to undefined behavior, don’t do that!

let _ = unsafe { Acronym::from_str_unchecked("HDHR") }; // must be 2 or 3 characters
let _ = unsafe { Acronym::from_str_unchecked("hd") };   // must be uppercase

pub fn as_str(&self) -> &str

Returns the Acronym as a string.

Example

use rosu_mods::Acronym;

let hd = "HD".parse::<Acronym>().unwrap();
assert_eq!(hd.as_str(), "HD");

Trait Implementations

impl Archive for Acronym

Available on crate feature rkyv only.

type Archived = Acronym

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.

fn resolve(&self, (): Self::Resolver, out: Place<Self::Archived>)

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

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl<__C: Fallible + ?Sized> CheckBytes<__C> for Acronym

where <__C as Fallible>::Error: Trace, [u8; 3]: CheckBytes<__C>,

unsafe fn check_bytes( value: *const Self, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

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

impl Clone for Acronym

fn clone(&self) -> Acronym

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Acronym

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Acronym

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<Acronym, D> for Acronym

Available on crate feature rkyv only.

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

Deserializes using the given deserializer

impl Display for Acronym

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

Formats the value using the given formatter.

impl FromStr for Acronym

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

Create an Acronym from a string.

Errors if the acronym consists of fewer than 2 or more than 3 bytes.

type Err = AcronymParseError

The associated error which can be returned from parsing.

impl Hash for Acronym

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 Ord for Acronym

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

Restrict a value to a certain interval.

impl PartialEq for Acronym

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Acronym

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Fallible + ?Sized> Serialize<S> for Acronym

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 Acronym

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 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 Acronym

impl Eq for Acronym

impl NoUndef for Acronym

Available on crate feature rkyv only.

impl Portable for Acronym

Available on crate feature rkyv only.

impl StructuralPartialEq for Acronym