diff options
| author | Fuwn <[email protected]> | 2021-05-23 14:03:24 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-05-23 14:03:24 -0700 |
| commit | 38410cb41eb6c13f669ee340d896b02efc1afb63 (patch) | |
| tree | f5e3c840e22cb25cf7d7f76401a118ecd48d4784 | |
| parent | fix(config): doc comment format (diff) | |
| download | whirl-38410cb41eb6c13f669ee340d896b02efc1afb63.tar.xz whirl-38410cb41eb6c13f669ee340d896b02efc1afb63.zip | |
docs(global): more documentation
| -rw-r--r-- | crates/whirl_db/src/lib.rs | 5 | ||||
| -rw-r--r-- | crates/whirl_prompt/src/lib.rs | 1 | ||||
| -rw-r--r-- | crates/whirl_server/src/distributor.rs | 1 | ||||
| -rw-r--r-- | crates/whirl_server/src/hub.rs | 1 |
4 files changed, 6 insertions, 2 deletions
diff --git a/crates/whirl_db/src/lib.rs b/crates/whirl_db/src/lib.rs index 35f05ae..4f8050e 100644 --- a/crates/whirl_db/src/lib.rs +++ b/crates/whirl_db/src/lib.rs @@ -14,13 +14,14 @@ #[macro_use] extern crate diesel; -pub mod models; +mod models; mod schema; use diesel::prelude::*; // use crate::db::models::*; +/// Establish a connection to the SQLite database. pub fn establish_connection() -> SqliteConnection { let database_url = std::env::var("DATABASE_URL").unwrap_or_else(|_| "whirl.sqlite3".to_string()); SqliteConnection::establish(&database_url) @@ -31,7 +32,7 @@ pub fn establish_connection() -> SqliteConnection { #[cfg(test)] #[test] #[ignore] -pub fn show_serials() { +fn show_serials() { use crate::{models::SerialNumber, schema::serial_numbers::dsl::*}; dotenv::dotenv().ok(); diff --git a/crates/whirl_prompt/src/lib.rs b/crates/whirl_prompt/src/lib.rs index 32b247f..f82459d 100644 --- a/crates/whirl_prompt/src/lib.rs +++ b/crates/whirl_prompt/src/lib.rs @@ -37,6 +37,7 @@ pub struct Prompt { history: Vec<String>, } impl Prompt { + /// Begin handling user input as the prompt. pub async fn handle() -> ! { let mut prompt = Prompt { history: vec![] diff --git a/crates/whirl_server/src/distributor.rs b/crates/whirl_server/src/distributor.rs index 22b698b..0d99c66 100644 --- a/crates/whirl_server/src/distributor.rs +++ b/crates/whirl_server/src/distributor.rs @@ -40,6 +40,7 @@ use crate::{ Server, }; +/// Spawn a Distributor. pub struct Distributor; #[async_trait] impl Server for Distributor { diff --git a/crates/whirl_server/src/hub.rs b/crates/whirl_server/src/hub.rs index 6de4bca..5bbc36a 100644 --- a/crates/whirl_server/src/hub.rs +++ b/crates/whirl_server/src/hub.rs @@ -37,6 +37,7 @@ use crate::{ Server, }; +/// Spawn a Hub. pub struct Hub; #[async_trait] impl Server for Hub { |