Skip to main content

SettingValue

Enum SettingValue 

Source
#[non_exhaustive]
pub enum SettingValue {
Show 13 variants DataDirectory(DirectorySetting), GameSetting(GameSettingType), UserData(DirectorySetting), DataLocal(DirectorySetting), Resources(DirectorySetting), Encoding(EncodingSetting), SubConfiguration(DirectorySetting), Generic(GenericSetting), Replace(GenericSetting), ContentFile(FileSetting), BethArchive(FileSetting), Groundcover(FileSetting), TrailingComment(TrailingComment),
}
Expand description

A single parsed entry from an openmw.cfg file.

Every line in the file is represented as one of these variants. The variant determines both the key that appears in the file and how the value is interpreted. Unknown keys are preserved as SettingValue::Generic so that round-trip serialisation never silently drops unrecognised entries.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

DataDirectory(DirectorySetting)

A data= entry specifying a VFS data directory.

§

GameSetting(GameSettingType)

A fallback= entry containing a Morrowind.ini-style key/value pair.

§

UserData(DirectorySetting)

A user-data= entry (singleton) specifying the user data root.

§

DataLocal(DirectorySetting)

A data-local= entry (singleton) specifying the highest-priority data directory.

§

Resources(DirectorySetting)

A resources= entry (singleton) specifying the engine resources directory.

§

Encoding(EncodingSetting)

An encoding= entry (singleton) specifying the text encoding (win1250/win1251/win1252).

§

SubConfiguration(DirectorySetting)

A config= entry referencing another openmw.cfg directory in the chain.

§

Generic(GenericSetting)

Any unrecognised key=value line, preserved verbatim.

§

Replace(GenericSetting)

A replace= entry. Loading applies it; serialization keeps it, so a saved file still discards what its parents defined when it is loaded again.

§

ContentFile(FileSetting)

A content= entry naming an ESP/ESM plugin file.

§

BethArchive(FileSetting)

A fallback-archive= entry naming a BSA archive file.

§

Groundcover(FileSetting)

A groundcover= entry naming a groundcover plugin file.

§

TrailingComment(TrailingComment)

Comment and blank lines after a file’s last setting, kept so serialization reproduces them; the serializer’s own version stamp is never one.

Implementations§

Source§

impl SettingValue

Source

pub fn meta(&self) -> &GameSettingMeta

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

Trait Implementations§

Source§

impl Clone for SettingValue

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SettingValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SettingValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<DirectorySetting> for SettingValue

Source§

fn from(d: DirectorySetting) -> Self

Converts to this type from the input type.
Source§

impl From<GameSettingType> for SettingValue

Source§

fn from(g: GameSettingType) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.