ids_service

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 a hash from both data. The size of random block is equal to 2 * the size of hash sha512 = 128 bytes.

So the size of data block to calculate a unique id using sha512 equal 128 bytes random + 8 bytes timestamp.

The hash algorithm can be one from crypto::sha3::Sha3Mode

The id can be:

• Vec <u8>
• String encoded hexadecimal lower case
• String as Base64
• String as Base32

Quick Start

Use of cached service:

extern crate ids_service;

use crate::ids_service::crypto_hash::{Encode,IdsService};

fn main() {

    /*
     * Create an ids service with:
     * Cache size = 100_000
     * hash algo. = sha256
     * A pool of 20 threads
     */
    let mut ids = IdsService::default();
    ids.start();
    // Optional: Wait cache is filled
    ids.filled_event().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();

}

Use of helper function:

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());

}

Run example

cargo run --example examples

cargo run --example iterator_example

cargo run --example quickstart

cargo run --example quickstart2;

Create ten millions of ids (sha512) and read it all. Throughput with i7, linux, 8 CPU's > 300'000 ids/s Throughput with Raspberry PI3 B+ 4 core > 25'000 ids/s

cargo run --release --example ten_million

Links

• Rust package library
• git repo master
• git repo 0.1.6

Releases

• 1.1.0 Changes:
  • Solve issues 1 & 2 with Raspberry and Windows 10 by changing multi threads management
  • Add functions:
    • fn stop(&mut self)
    • fn get_id_from_cache(&mut self) -> Option<Vec<u8>>
    • fn filled_event(&mut self) -> mpsc::Receiver<bool>
    • fn as_json(&self) -> String to Trait Encode
  • Solve all clippy warnings
  • Tests with Raspberry Pi3
  • Tests with Windows 10
  • Change default to sha256 and 100_000 cache size
• 1.0.2 Changes:
  • random block size from hash size to 2 * hash size see Birthday problem
  • Change default from sha512 to sha256
• 1.0.1 Add ten_million example
• 1.0.0 Refactor to no generic service, it uses cryptographic hash algorithm only. The internal multi-threads model is more efficient. The API is not compatible with 0.1.6.
• 0.1.6 add function to read configuration from toml file read_configuration_from_toml
• 0.1.5 Update readme and comments
• 0.1.4 Add two helper function to create on fly id create_id_as_u128 and create_id_as_string
• 0.1.0 to 0.1.3 Non functional, some adaptation for crates.io and bitbucket pipelines