Struct Cfg 

pub struct Cfg;

Config file helper

A simple helper for managing config files.

Implementations

impl Cfg

pub fn path(appname: &str, file: &str) -> PathBuf

Config file path

Returns the formatted path to a config file of an app.

pub fn read(appname: &str, file: &str) -> Result<String>

Read config file

Reads an app’s config file into a String. This can then be used to parse it via Serde.

Examples found in repository

examples/config.rs (line 14)

fn main() -> io::Result<()> {
	paintln!(Colors::Blue, "Saving test file...");
	Cfg::save(APP, FILE, PAYLOAD)?;

	paintln!(Colors::Cyan, "Reading test file...");
	let text = Cfg::read(APP, FILE)?;

	println!("Test file: {text}");
	assert_eq!(text, PAYLOAD.to_owned());
	Ok(())
}

examples/wallpaper-dl.rs (line 10)

fn main() {
	paint!(Colors::Green, "Your wallpaper-dl config: ");
	match Cfg::read(APP_NAME, CONFIG_FILE) {
		Err(_) => paintln!(Colors::YellowBold, "Not found"),
		Ok(x) => println!("\n{x}")
	}

	println!("\n{}\n", "=".repeat(36));

	paint!(Colors::Blue, "Your wallpaper database: ");
	match Appdata::read_str(APP_NAME, DB_FILE) {
		Err(_) => paintln!(Colors::RedBold, "Not found"),
		Ok(x) => println!("\n{x}")
	}
}

examples/alacritty.rs (line 7)

fn main() {
	paintln!(Colors::Rgb(42, 164, 69), "Attempting to read alacritty config file...");
	match Cfg::read("alacritty", "alacritty.toml") {
		Ok(data) => println!("Your alacritty config:\n{}", data),
		Err(_) => paintln!(Colors::Red, "You don't seem to have an alacritty config!"),
	}

	paintln!(Colors::Rgb(129, 69, 231), "But does your terminal support TrueColor?");
	paintln!(Colors::RgbBold(129, 69, 231), "And does it support Bold Colors???");
}

pub fn save(appname: &str, file: &str, data: impl AsRef<[u8]>) -> Result<()>

Save config file

Saves to an app’s config file. Note that this will override the file!

Examples found in repository

examples/config.rs (line 11)

fn main() -> io::Result<()> {
	paintln!(Colors::Blue, "Saving test file...");
	Cfg::save(APP, FILE, PAYLOAD)?;

	paintln!(Colors::Cyan, "Reading test file...");
	let text = Cfg::read(APP, FILE)?;

	println!("Test file: {text}");
	assert_eq!(text, PAYLOAD.to_owned());
	Ok(())
}

pub fn global_path(appname: &str, file: &str) -> PathBuf

Global config file path

Returns the formatted path to an app’s global config file.

pub fn global_read(appname: &str, file: &str) -> Result<String>

Read global config

Reads the global config file of an app into a String. Will most likely be parsed, e.g. via Serde.

pub fn global_save( appname: &str, file: &str, data: impl AsRef<[u8]>, ) -> Result<()>

Save global

Saves to an app’s global config file. Note that this will override the file!