https://github.com/bgrainger/nguid

.NET Library for creating GUIDs according to RFC 4122 and draft-ietf-uuidrev
https://github.com/bgrainger/nguid

csharp dotnet guid uuid

Last synced: about 2 months ago
JSON representation

.NET Library for creating GUIDs according to RFC 4122 and draft-ietf-uuidrev

• Host: GitHub
• URL: https://github.com/bgrainger/nguid
• Owner: bgrainger
• License: mit
• Created: 2023-07-01T01:18:59.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-19T11:26:48.000Z (10 months ago)
• Last Synced: 2024-07-02T21:13:35.388Z (6 months ago)
• Topics: csharp, dotnet, guid, uuid
• Language: C#
• Homepage:
• Size: 125 KB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NGuid

[![Continuous Integration](https://github.com/bgrainger/NGuid/actions/workflows/ci.yaml/badge.svg)](https://github.com/bgrainger/NGuid/actions/workflows/ci.yaml)

[![NuGet](https://img.shields.io/nuget/v/NGuid)](https://www.nuget.org/packages/NGuid)

## About

NGuid provides efficient creation of name-based, time-based, and random GUIDs according to

[RFC 4122](https://www.rfc-editor.org/rfc/rfc4122)

and [RFC 9562](https://www.rfc-editor.org/rfc/rfc9562):

* Version 3 ‒ created from an MD5 hash of a name

* Version 5 ‒ created from a SHA1 hash of a name

* Version 6 ‒ a field-compatible version of UUIDv1, reordered for improved DB locality

* Version 7 ‒ a time-ordered value based on a Unix timestamp

* Version 8 ‒ an RFC-compatible format for experimental or vendor-specific use cases

## Usage

```csharp

// returns a "Version 5" UUID by default: {74738ff5-5367-5958-9aee-98fffdcd1876}

var guidv5 = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8);

// can also create "Version 3": {0012416f-9eec-3ed4-a8b0-3bceecde1cd9}

var guidv3 = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8, version: 3);

// converts {6ba7b810-9dad-11d1-80b4-00c04fd430c8} to {1d19dad6-ba7b-6810-80b4-00c04fd430c8}

var guidv6 = GuidHelpers.CreateVersion6FromVersion1(GuidHelpers.DnsNamespace);

// creates a v7 GUID using the current time and random data

var guidv7 = GuidHelpers.CreateVersion7();

// .NET 8 only: specify a TimeProvider to provide the timestamp

var guidv7WithTime = GuidHelpers.CreateVersion7(TimeProvider.System);

// creates a v8 GUID using the specified data

ReadOnlySpan bytes = GetBytesFromSomewhere();

var guidv8 = GuidHelpers.CreateVersion8(bytes);

// creates a name-based v8 GUID using the specified hash algorithm

var guidv8ForName = GuidHelpers.CreateVersion8FromName(HashAlgorithmName.SHA256,

    GuidHelpers.DnsNamespace, "www.example.com"u8);

```

## License

[MIT](https://github.com/bgrainger/NGuid/blob/master/LICENSE)