Enum GameSettingType 

#[non_exhaustive]
pub enum GameSettingType {
    Color(ColorGameSetting),
    String(StringGameSetting),
    Float(FloatGameSetting),
    Int(IntGameSetting),
}

A typed fallback=Key,Value entry from an openmw.cfg file.

The value is parsed into the most specific type that fits:

• Three comma-separated integers in 0–255 → Color
• A number containing . that parses as f64 → Float
• A number that parses as i64 → Int
• Anything else → String

PartialEq comparisons are key-only within the same variant, matching OpenMW’s last-defined-wins deduplication semantics used by game_settings.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Color(ColorGameSetting)

An RGB colour triple (r,g,b).

String(StringGameSetting)

A plain string value (catch-all for values that aren’t numeric or colour).

Float(FloatGameSetting)

A floating-point value.

Int(IntGameSetting)

A 64-bit integer value.

Implementations

impl GameSettingType

pub fn key(&self) -> &String

Returns the setting key — the text before the first comma in a fallback=Key,Value entry.

use std::path::PathBuf;
use openmw_config::GameSettingType;
let setting = GameSettingType::try_from(
    ("iMaxLevel,50".to_string(), PathBuf::default(), &mut String::new())
).unwrap();
assert_eq!(setting.key(), "iMaxLevel");

pub fn key_str(&self) -> &str

Borrowed string view of Self::key.

pub fn kind_name(&self) -> &'static str

The kind’s name: Color, String, Float, or Int.

pub fn int_value(&self) -> Option<i64>

The parsed integer of an Int setting.

pub fn float_value(&self) -> Option<f64>

The parsed number of a Float setting.

pub fn color_value(&self) -> Option<(u8, u8, u8)>

The parsed (r, g, b) triple of a Color setting.

pub fn meta(&self) -> &GameSettingMeta

The file that defined the setting and the comment above it.

pub fn value(&self) -> Cow<'_, str>

Returns the setting value — the text after the first comma in a fallback=Key,Value entry.

use std::path::PathBuf;
use openmw_config::GameSettingType;
let setting = GameSettingType::try_from(
    ("iMaxLevel,50".to_string(), PathBuf::default(), &mut String::new())
).unwrap();
assert_eq!(setting.value(), "50");

pub fn value_str(&self) -> &str

Borrowed string view of Self::value.

Trait Implementations

impl Clone for GameSettingType

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GameSettingType

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

Formats the value using the given formatter.

impl Display for GameSettingType

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

Formats the value using the given formatter.

impl Eq for GameSettingType

impl From<GameSettingType> for SettingValue

fn from(g: GameSettingType) -> Self

Converts to this type from the input type.

impl PartialEq for GameSettingType

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for GameSettingType

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

Equality operator ==.

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

Inequality operator !=.

impl TryFrom<(String, PathBuf, &mut String)> for GameSettingType

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from( (original_value, source_config, queued_comment): (String, PathBuf, &mut String), ) -> Result<Self, ConfigError>

Performs the conversion.