Struct EnabledMods 

pub struct EnabledMods {
    pub client: bool,
    pub custom: bool,
    pub servers: bool,
    pub mods: BTreeMap<String, bool>,
    /* private fields */
}

Represents an enabledmods.json file. Core mods will default to true if not present when deserializing.

Fields

client: bool

custom: bool

servers: bool

mods: BTreeMap<String, bool>

Implementations

impl EnabledMods

pub fn load(path: impl AsRef<Path>) -> Result<Self, ThermiteError>

Attempts to read an EnabledMods from the path

Errors

• The file doesn’t exist
• The file isn’t formatted properly

pub fn default_with_path(path: impl AsRef<Path>) -> Self

Returns a default EnabledMods with the path property set

pub fn save(&self) -> Result<(), ThermiteError>

Saves the file using the path it was loaded from

Errors

• If the path isn’t set
• If there is an IO error

pub fn save_with_path( &mut self, path: impl AsRef<Path>, ) -> Result<(), ThermiteError>

👎Deprecated since 0.9: prefer explicitly setting the path and then saving

Saves the file using the provided path

Errors

• If there is an IO error

pub const fn path(&self) -> Option<&PathBuf>

Path the file will be written to

pub fn set_path(&mut self, path: impl Into<Option<PathBuf>>)

pub fn is_enabled(&self, name: impl AsRef<str>) -> bool

Returns the current state of a mod

Warning

Returns true if a mod is missing from the file

pub fn get(&self, name: impl AsRef<str>) -> Option<bool>

Get the current state of a mod if it exists

pub fn set(&mut self, name: impl AsRef<str>, val: bool) -> Option<bool>

Updates or inserts a mod’s state

Trait Implementations

impl Clone for EnabledMods

fn clone(&self) -> EnabledMods

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnabledMods

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

Formats the value using the given formatter.

impl Default for EnabledMods

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EnabledMods

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for EnabledMods

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 Serialize for EnabledMods

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.