Struct thermite::model::LocalIndex

pub struct LocalIndex {
    pub mods: BTreeMap<String, LocalMod>,
    pub linked: BTreeMap<String, LocalMod>,
    /* private fields */
}

Index of mods installed locally

Will save itself when it goes out of scope

Fields

mods: BTreeMap<String, LocalMod>

linked: BTreeMap<String, LocalMod>

Implementations

impl LocalIndex

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

Load an existing RON-format index file

Params

• path - Path to the index file to load

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

Tries to load an existing RON-format index file, or creates one if it doesn’t exist

Params

• path - Path to file to try to load

pub fn create(path: &Path) -> Self

Create a new index file

Params

• path - Path to create the file at

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

Save the index file

This function will be called when the LocalIndex is dropped. It shouldn’t need to be called manually.

pub fn parent_dir(&self) -> PathBuf

Returns the parent directory of the index file if available, or a default PathBuf otherwise

pub fn save_if_changed(&self) -> bool

Calls LocalIndex::save only if the index was modified

Returns whether or not the index was written to disk

pub fn path(&self) -> &PathBuf

pub fn path_mut(&mut self) -> &mut PathBuf

pub fn get_mod(&self, name: &str) -> Option<&LocalMod>

pub fn get_sub_mod(&self, name: &str) -> Option<&SubMod>

Trait Implementations

impl Clone for LocalIndex

fn clone(&self) -> LocalIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalIndex

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

Formats the value using the given formatter.

impl Default for LocalIndex

fn default() -> LocalIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for LocalIndex

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for LocalIndex

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 LocalIndex

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

Serialize this value into the given Serde serializer.