Struct IniFileSystem

Source
pub struct IniFileSystem { /* private fields */ }
๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate
Expand description

A hierarchical file system of IniFile.

example usage:

โ“˜
 use std::path::PathBuf;
 use rpkg_rs::misc::ini_file_system::IniFileSystem;

 let retail_path = PathBuf::from("Path to retail folder");
 let thumbs_path = retail_path.join("thumbs.dat");

 let thumbs = IniFileSystem::from(&thumbs_path.as_path())?;

 let app_options = &thumbs.root()?;

 if let (Some(proj_path), Some(runtime_path)) = (app_options.get("PROJECT_PATH"), app_options.get("RUNTIME_PATH")) {
    println!("Project path: {}", proj_path);
    println!("Runtime path: {}", runtime_path);
 }

Implementationsยง

Sourceยง

impl IniFileSystem

Source

pub fn new() -> Self

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate
Source

pub fn load(&mut self, root_file: impl AsRef<Path>) -> Result<(), IniFileError>

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate

Loads an IniFileSystem from the given root file.

Source

pub fn from(root_file: impl AsRef<Path>) -> Result<Self, IniFileError>

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate
Source

pub fn write_to_folder<P: AsRef<Path>>( &self, path: P, ) -> Result<(), IniFileError>

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate
Source

pub fn normalize(&mut self)

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate

Normalizes the IniFileSystem by merging sections and console commands from included files into the root file.

Source

pub fn console_cmds(&self) -> Vec<String>

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate

Retrieves all console commands from the IniFileSystem, including those from included files.

Source

pub fn option( &self, section_name: &str, option_name: &str, ) -> Result<String, IniFileError>

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate

Retrieves the value of an option in a section from the IniFileSystem, including values from included files.

Source

pub fn root(&self) -> &IniFile

๐Ÿ‘ŽDeprecated since 1.2.0: Replaced by dedicated glacier-ini crate

Retrieves a reference to the root IniFile of the IniFileSystem.

Trait Implementationsยง

Sourceยง

impl Debug for IniFileSystem

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Default for IniFileSystem

Sourceยง

fn default() -> IniFileSystem

Returns the โ€œdefault valueโ€ for a type. Read more
Sourceยง

impl<'de> Deserialize<'de> for IniFileSystem

Sourceยง

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

Deserialize this value from the given Serde deserializer. Read more
Sourceยง

impl Serialize for IniFileSystem

Sourceยง

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

Serialize this value into the given Serde serializer. Read more

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> 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> IntoEither for T

Sourceยง

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

impl<T> Pointable for T

Sourceยง

const ALIGN: usize

The alignment of pointer.
Sourceยง

type Init = T

The type for initializers.
Sourceยง

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Sourceยง

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Sourceยง

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Sourceยง

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

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

Sourceยง

type Error = Infallible

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

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

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.
Sourceยง

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,