OpenTally/src/lib.rs

59 lines
2.1 KiB
Rust
Raw Permalink Normal View History

/* OpenTally: Open-source election vote counting
* Copyright © 2021 Lee Yingtong Li (RunasSudo)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
2021-06-16 17:20:29 +10:00
#![warn(missing_docs)]
2021-10-27 19:52:51 +11:00
#![allow(clippy::collapsible_else_if, clippy::collapsible_if, clippy::comparison_chain, clippy::derive_ord_xor_partial_ord, clippy::needless_bool, clippy::needless_return, clippy::new_without_default, clippy::too_many_arguments)]
2021-06-16 17:20:29 +10:00
//! Open source counting software for various preferential voting election systems
/// Helper newtype for HashMap on [election::Candidate]s
pub mod candmap;
/// Data types and logic for constraints on elections
pub mod constraints;
2021-06-14 20:43:36 +10:00
/// Data types for representing abstract elections
pub mod election;
2021-06-14 20:43:36 +10:00
/// Smart logging framework
pub mod logger;
2021-06-14 20:43:36 +10:00
/// Implementations of different numeric representations
pub mod numbers;
/// File parsers
pub mod parser;
2021-06-14 20:43:36 +10:00
/// Deterministic random number generation using SHA256
2021-06-13 03:15:15 +10:00
pub mod sharandom;
2021-06-14 20:43:36 +10:00
/// STV counting logic
pub mod stv;
2021-06-14 20:43:36 +10:00
/// Tie-breaking methods
pub mod ties;
/// File writers
#[cfg(not(target_arch = "wasm32"))]
pub mod writer;
/// CLI implementations
#[cfg(not(target_arch = "wasm32"))]
pub mod cli;
use git_version::git_version;
#[allow(unused_imports)]
use wasm_bindgen::prelude::wasm_bindgen;
2021-06-14 20:43:36 +10:00
/// The git revision of this OpenTally build
pub const VERSION: &str = git_version!(args=["--always", "--dirty=-dev"], fallback="unknown");
2021-06-14 20:43:36 +10:00
/// Get [VERSION] as a String (for WebAssembly)
#[cfg_attr(feature = "wasm", wasm_bindgen)]
pub fn version() -> String { VERSION.to_string() }