4 releases
0.1.3 | Nov 21, 2020 |
---|---|
0.1.2 | Nov 21, 2020 |
0.1.1 | Nov 20, 2020 |
0.1.0 | Nov 20, 2020 |
#1165 in Data structures
14KB
68 lines
Identifier
Generate 128 bits id structs easily
Installation
[dependencies]
identifier = "0.1"
Version requirement: rustc 1.31+
Simple Example
Go to the generator section to see how to create one
use generators::uuid;
use identifier::{Display, FromStr, Identifier};
#[derive(Identifier, Eq, PartialEq, Display, FromStr)]
#[identifier(with = "uuid")]
pub struct UserId(u128);
fn main() {
let id = UserId::generate();
println!("generated user id: {}", id);
let parsed_id = "5ed9a942-223e-4639-a97c-6b6c41ac48d3".parse::<UserId>();
assert!(parsed_id.is_ok());
}
Example with a generator requiring params
use generators::random_id;
use identifier::{Display, FromStr, Identifier};
const KIND: u32 = 0x1111_ffff;
#[derive(Identifier, Eq, PartialEq, FromStr, Display)]
#[identifier(with = "random_id", params = "KIND, 0xabcd")]
pub struct PostId(u128);
fn main() {
let id = PostId::generate();
println!("generated post id: {}", id);
}
Generator
No params (with the uuid crate)
mod uuid {
use uuid::Uuid;
pub fn generate() -> u128 {
Uuid::new_v4().as_u128()
}
pub fn validate(value: u128) -> bool {
if let Some(Version::Random) = Uuid::from_u128(value).get_version() {
true
} else {
false
}
}
}
With params
mod random_id {
pub fn generate(kind: u32, seed: u16) -> u128 {
/* generate a random id with the given params ... */
}
pub fn validate(value: u128, kind: u32, _: u16) -> bool {
/* check it's a correct random id ... */
}
}
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~1.5MB
~37K SLoC