Adds all skeleton files

Essentialy an empty commit
This commit is contained in:
Dandaedre 2024-10-29 00:02:52 +01:00
parent 2ab2c6b5df
commit f870f41e31
10 changed files with 113 additions and 0 deletions

2
.cargo/config.toml Normal file
View File

@ -0,0 +1,2 @@
[build]
rustflags = ["-Clink-arg=-fuse-ld=mold", "-Ctarget-cpu=native"]

5
.gitignore vendored
View File

@ -14,3 +14,8 @@ Cargo.lock
# MSVC Windows builds of rustc generate these, which store debugging information
*.pdb
# Added by cargo
/target

18
Cargo.toml Normal file
View File

@ -0,0 +1,18 @@
[package]
name = "idlefox"
version = "0.1.0"
edition = "2021"
[dependencies]
[profile.dev]
debug = 0
[profile.release]
strip = true
lto = true
codegen-units = 1
panic = "abort"
[lints.rust]
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(tarpaulin_include)'] }

10
src/io.rs Normal file
View File

@ -0,0 +1,10 @@
//! All IO related functions, include all Discord IO functions
//!
//! Features:
//! All recv and send functions to discord
//! Helper function for advanced checks
#[cfg(test)]
mod tests {
// use super::*;
}

18
src/main.rs Normal file
View File

@ -0,0 +1,18 @@
//! A Rust Discord Bot, in charge of greatly simplifying the process of finding a meeting date, organising an event and choosing between several options.
//!
//!
// This line is here to force the use of extensive documentation
#![warn(clippy::missing_docs_in_private_items)]
mod io;
mod modules;
mod persistence;
mod server;
mod votes;
mod watchdog;
#[cfg(not(tarpaulin_include))]
fn main() {
println!("Hello, world!");
}

11
src/modules.rs Normal file
View File

@ -0,0 +1,11 @@
//! Modules handling all logic of votes, vote evolution and vote triggering, all IO links to here
//! This module republishes many outside modules
//!
//! Features:
//! Many handler functions
//! Every module encompassing a feature
#[cfg(test)]
mod tests {
// use super::*;
}

12
src/persistence.rs Normal file
View File

@ -0,0 +1,12 @@
//! Data persistence between runs, prevents data loss in the event of a crash
//!
//! Features:
//! Data persistence
//! Data integrity check (remote and local)
//!
//!
#[cfg(test)]
mod tests {
// use super::*;
}

11
src/server.rs Normal file
View File

@ -0,0 +1,11 @@
//! All server related features
//!
//! Features:
//! Show all votes (pending and happening)
//! Allow vote closing
//!
#[cfg(test)]
mod tests {
// use super::*;
}

14
src/votes.rs Normal file
View File

@ -0,0 +1,14 @@
//! Handles all votes related logic
//!
//! Features:
//! Structs & Traits
//! Votes (struct)
//! Event (struct)
//! ListCurrentEvents (struct)
//! ListFutureEvents (struct)
//!
#[cfg(test)]
mod tests {
// use super::*;
}

12
src/watchdog.rs Normal file
View File

@ -0,0 +1,12 @@
//! Event scheduler in charge of waiting out events and enabling them when times comes
//!
//! Features:
//! Time based garbage collector
//! Time managed events
//!
//!
#[cfg(test)]
mod tests {
// use super::*;
}