Struct etterna::Chartkey

pub struct Chartkey(_);

Represents an Etterna chartkey

Implementations

impl Chartkey

pub fn is_valid(key: &str) -> bool

Check if the given string represents a valid key

pub fn new(key: String) -> Option<Self>

Create a new key from the given string, or None if the string is invalid.

pub fn as_str(&self) -> &str

Get a reference to the underlying string

pub fn into_string(self) -> String

Convert this key into a String

Trait Implementations

impl AsRef<str> for Chartkey

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Chartkey

fn clone(&self) -> Chartkey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chartkey

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

Formats the value using the given formatter.

impl Display for Chartkey

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

Formats the value using the given formatter.

impl Eq for Chartkey

impl FromStr for Chartkey

type Err = ()

The associated error which can be returned from parsing.

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

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

impl Hash for Chartkey

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Chartkey> for Chartkey

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

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

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

This method tests for !=.

impl StructuralEq for Chartkey

impl StructuralPartialEq for Chartkey