unique-uuid 0.1.0

A library to generate unique UUIDs.
Documentation 
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

# unique-uuid


A Rust library that provides stable, cross-platform unique identifiers for types using UUIDs.

## Installation


Add this to your `Cargo.toml`:

```toml
[dependencies]
unique-uuid = "0.1.0"
```

## Usage


### Basic Type Tagging


```rust
use unique_uuid::UniqueTypeTag;

#[derive(UniqueTypeTag)]

struct MyType;

// Get the unique identifier for the type
let type_id = MyType::TYPE_TAG;
```

### Custom Tags


```rust
use unique_uuid_derive::unique_tag;

// Generate a unique identifier for a custom tag
let custom_id = unique_tag!("my-custom-tag");
```

## How It Works


The library generates and stores UUIDs in a `types.toml` file to ensure consistency across different compilations. Unlike `std::any::TypeId`, these identifiers remain stable across different builds and platforms.

## ⚠️ Known Limitations


Currently, structs with the same name (even in different modules or crates) will receive the same UUID. This is a known bug that will be addressed in future versions. Please ensure your struct names are unique across your entire project.

## Storage


UUIDs are stored in a `types.toml` file with the following structure:

```toml
[unique_tags]
"custom-tag" = "uuid-value"

[unique_type_tags]
"MyType" = "uuid-value"
```

## Contributing


Contributions are welcome! Please feel free to submit a Pull Request.