OpinionatedUids 1.0.0

.NET Standard 2.0
NuGet\Install-Package OpinionatedUids -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package OpinionatedUids --version 1.0.0
<PackageReference Include="OpinionatedUids" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OpinionatedUids --version 1.0.0
#r "nuget: OpinionatedUids, 1.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install OpinionatedUids as a Cake Addin
#addin nuget:?package=OpinionatedUids&version=1.0.0

// Install OpinionatedUids as a Cake Tool
#tool nuget:?package=OpinionatedUids&version=1.0.0

Opinionated Uids

What does it do?

Generates unique identifiers conforming to the Guid CLR type. We avoid the term "Guid" in our naming conventions, to avoid confusion with more standard ways of generating globally unique identifiers. Collision risk varies greatly, depending on the configuration.

How does it work?

We start with 16 cryptographically random bytes, then apply configured transforms (if any), then use configured judges (if any), to determine if a candidate identifier is acceptable.

If any judge deems a candidate identifier not acceptable, we try again, using a new cryptographically random identifier.

How to use?

This test code demonstrates a configuration with one opinion: the first byte of a Guid (when expressed in byte array form) should not be equal to 0x11 (decimal 17).

[Test]
[Repeat(10_000)]
public void TestSimpleProhibition()
{
    var services = new ServiceCollection();
    var buf = new byte[16] { 0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
    var prefixspec = new Guid(buf);
    var judge = new ProhibitedUidPrefix(prefixspec, 1); // second argument is length of the prefix to consider
    services.AddOpinionatedUids(judge);

    using (var sp = services.BuildServiceProvider())
    {
        var maker = sp.GetRequiredService<IOpinionatedUidMaker>();
        var uid = maker.NewUid();
        Assert.That(uid.ToByteArray().First(), Is.Not.EqualTo(0x11));
    }
}

Raw Guid Source

Raw Guid values are generated via the IRawGuidMaker interface, prior to being transformed and judged (as configured). The default implementation (RawGuidMaker) uses cryptographically random System.Security.Cryptography.RandomNumberGenerator. Note that Guid.NewGuid is not used anywhere in the process. If desired, an alternative IRawGuidMaker can be registered. An alternative IRawGuidMaker implemenation could use Guid.NewGuid, or some other means, to generate starting point identifiers.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 236 6/24/2021