Enum StringKey

pub enum StringKey {
    Num(u32),
    Name(String),
}

A key in a language file.

A key may be either a nonnegative integer or an arbitrary string.

The original game supports only nonnegative integers. The HD Edition allows for integers as well as Strings to serve as keys in a key value file.

Variants

Num(u32)

An integer string key.

Name(String)

A named string key. The string must not represent a u32 value (such keys must be Num).

Implementations

impl StringKey

pub fn is_numeric(&self) -> bool

Returns true if and only if this StringKey is a number.

Examples

use genie_support::StringKey;
use std::convert::TryFrom;
assert!(StringKey::try_from(0).unwrap().is_numeric());
assert!(!StringKey::from("").is_numeric());

pub fn is_named(&self) -> bool

Returns true if and only if this StringKey is a string name.

Examples

use genie_support::StringKey;
use std::convert::TryFrom;
assert!(!StringKey::try_from(0).unwrap().is_named());
assert!(StringKey::from("").is_named());

Trait Implementations

impl Clone for StringKey

fn clone(&self) -> StringKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringKey

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

Formats the value using the given formatter.

impl Default for StringKey

fn default() -> Self

Returns the “default value” for a type.

impl Display for StringKey

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

Formats the value using the given formatter.

impl From<&str> for StringKey

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for StringKey

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<u16> for StringKey

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for StringKey

fn from(n: u32) -> Self

Converts to this type from the input type.

impl Hash for StringKey

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 PartialEq for StringKey

fn eq(&self, other: &StringKey) -> 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 TryFrom<&StringKey> for i16

type Error = TryFromStringKeyError

The type returned in the event of a conversion error.

fn try_from(key: &StringKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&StringKey> for i32

type Error = TryFromStringKeyError

The type returned in the event of a conversion error.

fn try_from(key: &StringKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&StringKey> for u16

type Error = TryFromStringKeyError

The type returned in the event of a conversion error.

fn try_from(key: &StringKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&StringKey> for u32

type Error = TryFromStringKeyError

The type returned in the event of a conversion error.

fn try_from(key: &StringKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for StringKey

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(n: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for StringKey

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(n: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for StringKey

impl StructuralPartialEq for StringKey