This project adds a source generator to your project that creates identity types. It's used for types that identifies some resource. For example a user id or application id.
The source generator adds casting operators (explicit cast to, implicit cast from), equality checks, hash code, equals and ToString() (if it is not already provided).
It will get applied to a partial readonly struct that specifies IEquality on itself and has a single private readonly field with no constructors defined.
The struct currently must be declared in a namespace, i.e. you cannot declare them as inner types.
Example:
public readonly partial struct UserId : IEquatable<UserId>
{
private readonly Guid value;
}This is all you have to write. Notice that this struct would not normally compile, so if it doesn't there's probably something wrong. If you need more than a single field you can use a tuple on the value field. Note that the field doesn't have to be named value.
You can add additional methods or static fields.
Note that the default ToString() method uses InvariantCulture. This means that if the underlying type is a DateTime or DateTimeOffset the result will be the wonky US date format.
This library can also implement IComparable<T>. Simply add it to the list of interfaces and it should just work.
This will implement int CompareTo(T other) and the four value comparison operators.
This project, or more specifically the test project, requires Visual Studio 16.8 to build and/or the 5.0 (or newer) version of the .NET Core SDK toolchain.
If this is in order the project should build either through Visual Studio or dotnet build. A NuGet package will get built.
This program is licensed under the MIT license. Please see license.txt for details.