Enum StringKey

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

Expand description

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 copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for StringKey

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

Formats the value using the given formatter. Read more

impl Default for StringKey

fn default() -> StringKey

Returns the “default value” for a type. Read more

impl Display for StringKey

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

Formats the value using the given formatter. Read more

impl From<&str> for StringKey

fn from(s: &str) -> StringKey

Converts to this type from the input type.

impl From<String> for StringKey

fn from(s: String) -> StringKey

Converts to this type from the input type.

impl From<u16> for StringKey

fn from(n: u16) -> StringKey

Converts to this type from the input type.

impl From<u32> for StringKey

fn from(n: u32) -> StringKey

Converts to this type from the input type.

impl Hash for StringKey

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for StringKey

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

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

1.0.0 · Source§

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

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(n: i16) -> Result<StringKey, <StringKey as TryFrom<i16>>::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<StringKey, <StringKey as TryFrom<i32>>::Error>

Performs the conversion.

impl Eq for StringKey

impl StructuralPartialEq for StringKey

Auto Trait Implementations§

impl Freeze for StringKey

impl RefUnwindSafe for StringKey

impl Send for StringKey

impl Sync for StringKey

impl Unpin for StringKey

impl UnwindSafe for StringKey

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.