Skip to content

Commit

Permalink
Release 1.0.1
Browse files Browse the repository at this point in the history
- simplified ULID generation code
  • Loading branch information
mrothNET committed Oct 31, 2024
1 parent 64c2fe5 commit 37e1cbe
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "mr-ulid"
description = "Robust and Hassle-Free ULIDs (Universally Unique Lexicographically Sortable Identifier)"
version = "1.0.0"
version = "1.0.1"
edition = "2021"

categories = ["encoding", "data-structures", "web-programming"]
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ By providing both `Ulid` and `ZeroableUlid` types, it serves different applicati
- **Minimal Dependencies**: Actually no dependencies required, only `rand` enabled by default as Rust lacks a built-in random number generator.
- **Optional Features**: Supports `serde` for serialization and deserialization.

## Guarantees

A notable feature of this crate is the guarantee that a sufficient number of ULIDs can be generated at any time without failing or the random part overflowing.

The 80-bit random component of a ULID is slightly reduced by 10<sup>10</sup> values, resulting in a negligible reduction in entropy of approximately 0.000000000001%. This ensures that at least 10<sup>10</sup> ULIDs can be generated per _millisecond_, equating to 10<sup>13</sup> ULIDs per _second_. Such capacity exceeds the capabilities of current systems by magnitudes.

## Installation

Add `mr-ulid` to your `Cargo.toml`:
Expand Down Expand Up @@ -93,12 +99,6 @@ fn main() {
}
```

## Guarantees

A notable feature of this crate is the guarantee that a sufficient number of ULIDs can be generated at any time without failing or the random part overflowing.

The 80-bit random component of a ULID is slightly reduced by 10<sup>10</sup> values, resulting in a negligible reduction in entropy of approximately 0.000000000001%. This ensures that at least 10<sup>10</sup> ULIDs can be generated per _millisecond_, equating to 10<sup>13</sup> ULIDs per _second_. Such capacity exceeds the capabilities of current systems by magnitudes.

## Contributing

Contributions are welcome! Whether it's a bug fix, new feature, or improvement, your help is appreciated. Please feel free to open issues or submit pull requests on the [GitHub repository](https://github.com/mrothNET/mr-ulid).
Expand Down

0 comments on commit 37e1cbe

Please sign in to comment.