Rust/umanux
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

add some documentation

Browse Source
This commit is contained in:
Dietrich 2020-10-18 08:50:19 +02:00
parent abdb704ba0
commit 60bbe1ef1b
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/userlib.rs
View File

@ -1,6 +1,6 @@
#![warn( #![warn(
clippy::all, clippy::all,
/* clippy::restriction,*/ clippy::restriction,
clippy::pedantic, clippy::pedantic,
clippy::nursery, clippy::nursery,
clippy::cargo clippy::cargo
@ -26,6 +26,7 @@ pub struct Files {
} }
impl Default for Files { impl Default for Files {
/// use the default Linux `/etc/` paths
fn default() -> Self { fn default() -> Self {
Self { Self {
passwd: Some(PathBuf::from("/etc/passwd")), passwd: Some(PathBuf::from("/etc/passwd")),
@ -36,6 +37,7 @@ impl Default for Files {
} }
impl UserDBLocal { impl UserDBLocal {
/// Import the database from strings
#[must_use] #[must_use]
pub fn import_from_strings( pub fn import_from_strings(
passwd_content: &str, passwd_content: &str,
@ -58,6 +60,7 @@ impl UserDBLocal {
res res
} }
/// Import the database from a [`Files`] struct
#[must_use] #[must_use]
pub fn load_files(files: Files) -> Self { pub fn load_files(files: Files) -> Self {
let my_passwd_lines = file_to_string(files.passwd.as_ref()); let my_passwd_lines = file_to_string(files.passwd.as_ref());
@ -75,6 +78,7 @@ impl UserDBLocal {
} }
} }
/// Parse a file to a string
fn file_to_string(path: Option<&PathBuf>) -> String { fn file_to_string(path: Option<&PathBuf>) -> String {
let file = File::open(path.expect("Path cannot be None".into())) let file = File::open(path.expect("Path cannot be None".into()))
.expect("Failed to read the file. Most of the time root permissions are needed".into()); .expect("Failed to read the file. Most of the time root permissions are needed".into());
@ -84,7 +88,7 @@ fn file_to_string(path: Option<&PathBuf>) -> String {
lines lines
} }
/// Merge the Shadow passwords into the users. /// Merge the Shadow passwords into the users
fn shadow_to_users( fn shadow_to_users(
users: &mut HashMap<String, crate::User>, users: &mut HashMap<String, crate::User>,
shadow: Vec<crate::Shadow>, shadow: Vec<crate::Shadow>,
@ -98,7 +102,7 @@ fn shadow_to_users(
users users
} }
/// Convert a `Vec<crate::User>` to a `HashMap<String, crate::User>` where the username is used as key. /// Convert a `Vec<crate::User>` to a `HashMap<String, crate::User>` where the username is used as key
fn user_vec_to_hashmap(users: Vec<crate::User>) -> HashMap<String, crate::User> { fn user_vec_to_hashmap(users: Vec<crate::User>) -> HashMap<String, crate::User> {
users users
.into_iter() .into_iter()
@ -116,6 +120,7 @@ pub trait NewFromString {
Self: Sized; Self: Sized;
} }
/// A generic function that parses a string line by line and creates the appropriate `Vec<T>` requested by the type system.
fn string_to<T>(source: &str) -> Vec<T> fn string_to<T>(source: &str) -> Vec<T>
where where
T: NewFromString, T: NewFromString,