apputils 0.1.6

A lightweight Rust crate to help you build awesome tools
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use crate::dirs::{config_home, data_home};
use std::path::{Path, PathBuf};
use std::fs;
use std::io;

/// Config file helper
/// 
/// A simple helper for managing config files.
pub struct Cfg;
impl Cfg {
	/// Config file path
	/// 
	/// Returns the formatted path to a config file of an app.
	pub fn path(appname: &str, file: &str) -> PathBuf {
		local_cfg_dir(appname).join(file)
	}

	/// Read config file
	/// 
	/// Reads an app's config file into a [String].
	/// This can then be used to parse it via Serde.
	pub fn read(appname: &str, file: &str) -> io::Result<String> {
		fs::read_to_string(Self::path(appname, file))
	}

	/// Save config file
	/// 
	/// Saves to an app's config file. Note that this will override the file!
	pub fn save(appname: &str, file: &str, data: impl AsRef<[u8]>) -> io::Result<()> {
		fs::create_dir_all(local_cfg_dir(appname))?;
		fs::write(Self::path(appname, file), data)
	}

	/// Global config file path
	/// 
	/// Returns the formatted path to an app's global config file.
	pub fn global_path(appname: &str, file: &str) -> PathBuf {
		global_cfg_dir(appname).join(file)
	}

	/// 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_read(appname: &str, file: &str) -> io::Result<String> {
		fs::read_to_string(Self::global_path(appname, file))
	}

	/// Save global
	/// 
	/// Saves to an app's global config file. Note that this will override the file!
	pub fn global_save(appname: &str, file: &str, data: impl AsRef<[u8]>) -> io::Result<()> {
		fs::create_dir_all(global_cfg_dir(appname))?;
		fs::write(Self::global_path(appname, file), data)
	}
}

/// Local config folder
/// 
/// Returns the path to your app's local config folder.  
/// `appname`: The short name of your app in lower case.
pub fn local_cfg_dir(appname: &str) -> PathBuf {
	config_home().join(appname)
}

/// Global config folder
/// 
/// Returns the path to your app's global config folder.  
/// `appname`: The short name of your app in lower case.
/// 
/// Due to there not being a proper `/etc` equivalent on Windows,
/// this defaults to the [local](local_cfg_dir) config folder on Windows.
pub fn global_cfg_dir(appname: &str) -> PathBuf {
	if cfg!(target_family = "unix") {
		Path::new("/etc").join(appname)
	} else {
		local_cfg_dir(appname)
	}
}

/// Appdata helper
/// 
/// A simple 
pub struct Appdata;
impl Appdata {
	/// Appdata file path
	/// 
	/// Returns the formatted path to a data file of an app.
	pub fn path(appname: &str, file: &str) -> PathBuf {
		local_data_dir(appname).join(file)
	}

	/// Unicode Read
	/// 
	/// Reads a text file from the app's data folder.
	pub fn read_str(appname: &str, file: &str) -> io::Result<String> {
		fs::read_to_string(Self::path(appname, file))
	}
	
	/// Binary Read
	/// 
	/// Reads a binary file from the app's data folder.
	pub fn read(appname: &str, file: &str) -> io::Result<Vec<u8>> {
		fs::read(Self::path(appname, file))
	}

	/// Save data file
	/// 
	/// Saves the data file of an app. Note that this overrides the target file!
	pub fn save(appname: &str, file: &str, data: impl AsRef<[u8]>) -> io::Result<()> {
		fs::create_dir_all(local_data_dir(appname))?;
		fs::write(Self::path(appname, file), data)
	}
}

/// Application data folder
/// 
/// Returns the path to your app's data folder.  
/// `appname`: The short name of your app in lower case.
pub fn local_data_dir(appname: &str) -> PathBuf {
	data_home().join(appname)
}