1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/*
* This file is part of ids_service
*
* ids_service is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* ids_service 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with ids_service. If not, see <http://www.gnu.org/licenses/>
*/
//! Library that allows generating unique ids. It tried to keep cache filled using background threads
//! to fill it.
//! If the cache is empty (the number of requests is too high) an id is calculated on the fly.
//! This will slow down obtaining the id but there is no error when the cache is empty.
//! To generate unique ids the library uses an array of bytes with values from a random number generator
//! and a timestamp as nanoseconds since January 1, 1970 UTC and finally create an hash from both data's.
//!
//! The library is composed of two modules with similar API but different hash algorithms:
//!
//! ## crypto_hash:
//! The hash algorithm can be one from [crypto::sha3::Sha3Mode](https://docs.rs/rust-crypto/0.2.36/crypto/sha3/enum.Sha3Mode.html).
//!
//! ## rust_hash:
//! The hash algorithm is the [std::collections::hash_map::DefaultHasher] from Rust sdt.
//!
//! According to your requirements, you may choose which modules you need. The negative impact of
//! using crypto_hash is the performance and resources to run service.
//! Throughput of ids/sec is about half compared to rust DefaultHasher.
//! The indicative throughput with an Intel I7 using sha512 is above 750'000 ids/sec using Rust Hash
//! the throughput is above 900'000 ids/sec.
//!
//! The size of random block is equal to 2 * the size of hash sha512 = 128 bytes.
//! The size of data block to calculate an unique id using sha512 equal 128 bytes random + 8 bytes of
//! timestamp.
//!
//! The id can be encode as:
//! * String encoded hexadecimal lower case
//! * String as Base64
//! * String as Base32
//! * Json
//!
//! # Quick Start
//!
//! ## crypto_hash:
//! ```
//! extern crate ids_service;
//!
//! use crate::ids_service::crypto_hash::*;
//! use crate::ids_service::common::*;
//!
//! fn main() {
//!
//! /*
//! * Create an ids service with:
//! * Cache size = 100'000
//! * hash algo. = sha256
//! * A pool of threads = to the cpu numbers
//! */
//! let mut ids = IdsService::default();
//! ids.start();
//! // Optional: Wait cache is filled at 10%
//! ids.filled_at_percent_event(10).recv().is_ok();
//! println!("Get an id: {}", ids.get_id().as_hex());
//! println!("Get another id: {}", ids.get_id().as_base64());
//! println!("Get an id from cache: {}", ids.get_id_from_cache().expect("Expect an id").as_hex());
//! println!("Current numbers of items in cache: {}", ids.get_cache_len());
//! // Graceful Shutdown and Cleanup
//! ids.stop();
//! }
//! ```
//! Create an hash without caching service
//!
//! ```
//! extern crate ids_service;
//!
//! use crate::ids_service::crypto_hash::*;
//!
//! fn main() {
//!
//! println!("Create an id sha512 without the service: {}", create_id_as_sha512());
//! println!("Create an id sha256 without the service: {}", create_id_as_sha256());
//!
//! }
//! ```
//! The lib use simplelog see for configuration:
//! [crates.io Rust Package Registry SimpleLog ](https://crates.io/crates/simplelog).
//!
//! ## rust_hash:
//!
//! ```
//! extern crate ids_service;
//!
//! use crate::ids_service::rust_hash::*;
//! use crate::ids_service::common::*;
//!
//!
//! fn main() {
//!
//! /*
//! * Create an ids service with:
//! * Cache size = 100'000
//! * hash algo. = rust SipHasher
//! * A pool of threads = to the cpu numbers
//! */
//! let mut ids = IdsService::default();
//! ids.start();
//! // Optional: Wait cache is filled at 100%
//! ids.filled_event().recv().is_ok();
//! println!("Get an id: {}", ids.get_id());
//! println!("Get an id: {}", ids.get_id().as_hex());
//! println!("Get an id: {}", ids.get_id().as_base64());
//! println!("Get an id: {}", ids.get_id().as_json());
//! println!("Get an id from cache: {}", ids.get_id_from_cache().expect("Expect an id"));
//! println!("Current numbers of items in cache: {}", ids.get_cache_len());
//! // Graceful Shutdown and Cleanup
//! ids.stop();
//! }
//! ```
//! Create an hash without caching service
//!
//! ```
//!
//! extern crate ids_service;
//!
//! use crate::ids_service::rust_hash::*;
//!
//! fn main() {
//!
//! println!("Create an id without the service: {}", create_id().unwrap());
//! println!("Create an id without the service: {}", create_id().unwrap());
//!
//! }
//!
//! ```
#[macro_use]
extern crate lazy_static;
extern crate num_cpus;
pub mod crypto_hash;
pub mod rust_hash;
pub use self::crypto_hash::*;
pub use self::rust_hash::*;
/// Module with shared part of lib.
pub mod common {
// Default number of thread's is equal to the number of cpu's. Tests demonstrated
// it's good default value
lazy_static!(
pub static ref NUMBER_OF_FILL_THREAD: usize = num_cpus::get();
);
/// Trait to define possible encoding output.
pub trait Encode: Sized {
fn as_hex(&self) -> String {
unimplemented!()
}
fn as_base64(&self) -> String {
unimplemented!()
}
fn as_base64_url(&self) -> String {
unimplemented!()
}
fn as_base32(&self) -> String {
unimplemented!()
}
fn as_json(&self) -> String {
unimplemented!()
}
}
/// Trait with functions to get an id
pub trait Uids {
type Id;
/// Get an id from cache, if the cache is empty. The function try to create an id on fly.
fn get_id(&mut self) -> Self::Id {
unimplemented!()
}
/// Get an id from cache. If cache is empty it return None.
fn get_id_from_cache(&mut self) -> Option<Self::Id>{
unimplemented!()
}
}
/// Trait with usual functions of service
pub trait Service {
fn start(&mut self) {
unimplemented!()
}
fn stop(&mut self) {
unimplemented!()
}
fn restart(&mut self) {
self.stop();
self.start();
}
}
}