uuid-by-string 3.0.1

Generating uuid-hash from string
Documentation

uuid-by-string Crates.io Downloads

Generates the RFC-4122 Name-Based UUID. Supports 3 and 5 versions of UUID with and without (non-standard, see below) a namespace.

🚨 Warning: Don't use unless explicitly necessary (see replacement) 🚨

Note: generating UUID v3 and v5 without a namespace is non-standard (the RFC-4122 covers only the case when you concatenate the namespace with the name, so if you want a reproducable result in other progrmming langiages you need to generate UUID with some namespace, e.g. nil)

According to the implementation differences, it's impossible to replicate results of the no-namespace UUID generation with a standard generation, so keep that in mind.

This library is rewritten from Danakt Saushkin's JavaScript library of the same name. All features and tests are in place.

Installation

cargo add uuid-by-string

Usage

use uuid_by_string::uuid;
uuid::generate("hello world", Some("d3486ae9-136e-5856-bc42-212385ea7970")).unwrap()
//"1825ed38-348f-5b46-99de-fd84b83aba5e"

// You can skip UUID and the nil UUID will be used as default
uuid::generate("hello world", None).unwrap()
//"191333f6-c83e-5b3b-bdb0-bd483ad1bcb7"

use uuid_by_string::uuid_no_namespace;
// Note: generating UUID v3 and v5 without namespace is non-standard
uuid_no_namespace::generate("hello world")
//"2aae6c35-c94f-5fb4-95db-e95f408b9ce9";

The string hello world will always return 2aae6c35-c94f-5fb4-95db-e95f408b9ce9.

You can specify the UUID version. Available versions is 3 and 5 according to RFC-4122. The version is responsible for the hashing algorithm: version 3 uses MD5, and version 5 uses SHA-1. UUIDv5 is used by default if version is not specified.

use uuid_by_string::uuid;
use uuid_by_string::uuid_no_namespace;

fn main() {
    assert_eq!(uuid::generate_v3("hello world", Some("d3486ae9-136e-5856-bc42-212385ea7970")), Ok("c8aeb76a-1204-3f07-995e-5c5fa3494b7f".to_owned()));
    assert_eq!(uuid::generate_v3("hello world", Some("D3486AE9-136e-5856-bc42-212385ea7970")), Ok("c8aeb76a-1204-3f07-995e-5c5fa3494b7f".to_owned()));
    assert_eq!(uuid::generate_v5("hello world", Some("d3486ae9-136e-5856-bc42-212385ea7970")), Ok("1825ed38-348f-5b46-99de-fd84b83aba5e".to_owned()));
    assert_eq!(uuid::generate_v5("hello world", Some("D3486AE9-136e-5856-bc42-212385ea7970")), Ok("1825ed38-348f-5b46-99de-fd84b83aba5e".to_owned()));

    // Note: generating UUID v3 and v5 without namespace is non-standard
    assert_eq!(uuid_no_namespace::generate_v3("hello world"), "5eb63bbb-e01e-3ed0-93cb-22bb8f5acdc3");
    assert_eq!(uuid_no_namespace::generate_v5("hello world"), "2aae6c35-c94f-5fb4-95db-e95f408b9ce9");
}

Replacement

You can (and should) replace this library with https://docs.rs/uuid/. The code whould look like this:

use uuid::Uuid;

let uuid = Uuid::new_v3(&Uuid::nil(), b"Hello world!");
let uuid = Uuid::new_v5(&Uuid::nil(), b"Hello world!");

More info about replacement: