documentation update

* satisfy compiler when warnings are enabled
  e.g. lib.rs include #!(warn(missing_docs))

Signed-off-by: Ralf Zerres <ralf.zerres@networkx.de>

src/functions/harms.rs

@@ -69,6 +69,7 @@ impl Harm {
     }
      */
 
+    /// get list of all harm record
     pub fn get_all(connection: &SqliteConnection) -> Box<Vec<Harm>> {
         Box::new(
             harms
@@ -78,6 +79,7 @@ impl Harm {
         )
     }
 
+    /// get harm record
     pub fn get(
         param_id_harm: &str,
         connection: &SqliteConnection,
@@ -91,6 +93,7 @@ impl Harm {
         Ok(query)
     }
 
+    /// update harm record
     pub fn update(
         param_id: i32,
         param_id_harm: &str,
@@ -106,6 +109,7 @@ impl Harm {
     }
 }
 
+/// set  a test harm record
 pub fn set_harms_single_column(connection: &SqliteConnection) -> QueryResult<usize> {
     insert_into(harms)
         .values(id_harm.eq("123456789"))
@@ -113,6 +117,7 @@ pub fn set_harms_single_column(connection: &SqliteConnection) -> QueryResult<usi
 }
 
 #[test]
+/// examine the test harm record
 fn examine_set_harms_single_column() {
     let query = insert_into(harms).values(id_harm.eq("123456789"));
     let sql = "INSERT INTO `harms` (`id_harm`) VALUES (?) \
@@ -120,6 +125,7 @@ fn examine_set_harms_single_column() {
     assert_eq!(sql, debug_query::<Sqlite, _>(&query).to_string());
 }
 
+/// set multiple collumns for the test harm record
 pub fn set_harms_multi_column(connection: &SqliteConnection) -> QueryResult<usize> {
     insert_into(harms)
         .values((

src/functions/tests.rs

@@ -16,7 +16,7 @@ use diesel::sqlite::SqliteConnection;
 
 use crate::schema;
 
-// defaults
+/// set user defaults
 pub fn set_users_default_values(connection: &SqliteConnection) -> QueryResult<usize> {
     use schema::users::dsl::*;
 
@@ -24,6 +24,7 @@ pub fn set_users_default_values(connection: &SqliteConnection) -> QueryResult<us
 }
 
 #[test]
+/// examine results when setting user defaults
 fn examine_set_users_default_values() {
     use schema::users::dsl::*;
 
@@ -32,6 +33,7 @@ fn examine_set_users_default_values() {
     assert_eq!(sql, debug_query::<Sqlite, _>(&query).to_string());
 }
 
+/// set user defaults
 pub fn set_roles_default_values(connection: &SqliteConnection) -> QueryResult<usize> {
     use schema::roles::dsl::*;
 
@@ -39,6 +41,7 @@ pub fn set_roles_default_values(connection: &SqliteConnection) -> QueryResult<us
 }
 
 #[test]
+/// examine results when setting user defaults
 fn examine_set_roles_default_values() {
     use schema::roles::dsl::*;
 
@@ -47,6 +50,7 @@ fn examine_set_roles_default_values() {
     assert_eq!(sql, debug_query::<Sqlite, _>(&query).to_string());
 }
 
+/// set user roles defaults
 pub fn set_user_roles_default_values(connection: &SqliteConnection) -> QueryResult<usize> {
     use schema::user_roles::dsl::*;
 
@@ -54,6 +58,7 @@ pub fn set_user_roles_default_values(connection: &SqliteConnection) -> QueryResu
 }
 
 #[test]
+/// examine results when setting user roles defaults
 fn examine_set_user_roles_default_values() {
     use schema::user_roles::dsl::*;
 
@@ -62,6 +67,7 @@ fn examine_set_user_roles_default_values() {
     assert_eq!(sql, debug_query::<Sqlite, _>(&query).to_string());
 }
 
+/// set harm defaults
 pub fn set_harms_default_values(connection: &SqliteConnection) -> QueryResult<usize> {
     use schema::harms::dsl::*;
 
@@ -69,6 +75,7 @@ pub fn set_harms_default_values(connection: &SqliteConnection) -> QueryResult<us
 }
 
 #[test]
+/// examine results when setting harm defaults
 fn examine_set_harms_default_values() {
     use schema::harms::dsl::*;
 
@@ -77,6 +84,7 @@ fn examine_set_harms_default_values() {
     assert_eq!(sql, debug_query::<Sqlite, _>(&query).to_string());
 }
 
+/// set a users email-confirmed column
 pub fn set_users_email_confirmed(connection: &SqliteConnection) -> QueryResult<usize> {
     use schema::users::dsl::*;
 
@@ -85,6 +93,7 @@ pub fn set_users_email_confirmed(connection: &SqliteConnection) -> QueryResult<u
         .execute(connection)
 }
 
+/// set a user column
 pub fn set_users_single_column(connection: &SqliteConnection) -> QueryResult<usize> {
     use schema::users::dsl::*;
 
@@ -94,6 +103,7 @@ pub fn set_users_single_column(connection: &SqliteConnection) -> QueryResult<usi
 }
 
 #[test]
+/// examine results when setting a single user column
 fn examine_set_users_single_column() {
     use schema::users::dsl::*;
 
@@ -103,6 +113,7 @@ fn examine_set_users_single_column() {
     assert_eq!(sql, debug_query::<Sqlite, _>(&query).to_string());
 }
 
+/// set multiple user columns
 pub fn set_users_multiple_columns(connection: &SqliteConnection) -> QueryResult<usize> {
     use schema::users::dsl::*;
 
@@ -116,6 +127,7 @@ pub fn set_users_multiple_columns(connection: &SqliteConnection) -> QueryResult<
 }
 
 #[test]
+/// examine results when setting multiple user columns
 fn examine_set_user_multiple_columns() {
     use schema::users::dsl::*;
 
@@ -132,6 +144,7 @@ fn examine_set_user_multiple_columns() {
 
 /*
 #[test]
+/// examine results when setting user columns via json
 fn examine_set_user_struct_json() {
     use crate::models::users::NewUser;
     use schema::users::dsl::*;
@@ -162,13 +175,14 @@ fn examine_set_user_struct_json() {
 */
 
 #[test]
+/// examine results when setting user columns via json options
 fn examine_set_user_struct_json_option() {
     use crate::models::users::NewUser;
     use schema::users::dsl::*;
     use serde_json;
 
     let json = r#"{ "last_name": "Knocke", "first_name": null, "alias_name": null, "email": "knocke@kanzlei.hiedemann.de", "email_confirmed": 1, "initials": "dkn", "password_hash": "test", "date_created": null, "id_changed": 1, "date_changed": null }"#;
-    let user_struct = serde_json::from_str::<NewUser>(json).unwrap();
+    let user_struct = serde_json::from_str::<'_>(json).unwrap();
     let query = diesel::insert_into(users).values(&user_struct);
     let sql = "INSERT INTO `users` (`last_name`, `email`, `email_confirmed`, `initials`, `password_hash`, `id_changed`) \
                VALUES (?, ?, ?, ?, ?, ?) \

src/functions/users.rs

@@ -13,7 +13,8 @@ use diesel::sqlite::Sqlite;
 #[cfg(test)]
 use diesel::sqlite::SqliteConnection;
 use diesel::{QueryDsl, RunQueryDsl};
-use serde_json;
+// WIP: json functionality need work!
+// use serde_json;
 use std::error::Error;
 
 //use crate::models::users::{NewUser, RegisterUser, User, UserList};
@@ -95,12 +96,12 @@ impl User {
         Ok(())
     }
 
-    // create a hash value for the user password
+    /// create a hash value for the user password
     pub fn hash_password(plain: &str) -> Result<String, Box<dyn Error>> {
         Ok(hash(plain, DEFAULT_COST)?)
     }
 
-     /// update the confirmation status of a user emak address
+    /// update the confirmation status of a user emak address
     pub fn set_users_email_confirmed(connection: &SqliteConnection) -> QueryResult<usize> {
         diesel::update(users)
             .set(email_confirmed.eq(1))

src/models/users.rs

@@ -43,15 +43,25 @@ pub struct User {
 #[derive(Debug, Deserialize, Insertable, Serialize)]
 #[table_name = "users"]
 pub struct NewUser<'a> {
+    /// Lifetime for users last name
     pub last_name: &'a str,
+    /// Lifetime for users first name
     pub first_name: Option<&'a str>,
+    /// Lifetime for users alias name
     pub alias_name: Option<&'a str>,
+    /// Lifetime for users users email
     pub email: Option<&'a str>,
+    /// Lifetime for users email-confirmed
     pub email_confirmed: Option<i32>,
+    /// Lifetime for users initials
     pub initials: Option<&'a str>,
+    /// Lifetime for users password hash
     pub password_hash: &'a str,
+    /// Optional timestamp for cration date
     pub date_created: Option<NaiveDateTime>,
+    /// Optional userid that changed the record
     pub id_changed: i32,
+    /// Optional timestamp for the change date
     pub date_changed: Option<NaiveDateTime>,
 }
 
@@ -63,12 +73,19 @@ pub struct RegisterUser<'a> {
     pub last_name: &'a str,
     /// Lifetime of users first name
     pub first_name: Option<&'a str>,
+     /// Lifetime for users alias name column
     pub alias: Option<&'a str>,
+     /// Lifetime for users email column
     pub email: Option<&'a str>,
-    pub email_confirmed: Option<i32>,
+     /// Lifetime for users email confirmed column
+   pub email_confirmed: Option<i32>,
+    /// Lifetime for users initials
     pub initials: Option<&'a str>,
+    /// Lifetime for users password hash
     pub password_hash: &'a str,
+    /// Lifetime for users password confirmation
     pub password_confirmation: &'a str,
+    /// Optional userid that changed the record
     pub id_changed: i32,
 }