Renamed samples and updated readme

README.md

@@ -20,6 +20,8 @@ This library provides some interfaces, classes, [Roslyn Source Generators](https
 * [Smart Enum](#smart-enums)
 * [Value Objects](#value-objects)
 * [Discriminated Unions](#discriminated-unions) (requires version 8.x.x)
+  * [Ad hoc unions](#ad-hoc-unions)
+  * [Regular unions](#regular-unions)
 
 # Documentation
 
@@ -468,8 +470,12 @@ Install: `Install-Package Thinktecture.Runtime.Extensions` (requires version 8.x
 
 Documentation: [Discriminated Unions](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Discriminated-Unions)
 
+There are 2 types of unions: `ad hoc union` and `"regular" unions`
+
+## Ad hoc unions
+
 Features:
-* Roslyn Analyzers and CodeFixes help the developers to implement the Discriminated Unions correctly
+* Roslyn Analyzers and CodeFixes help the developers to implement the unions correctly
 * Provides proper implementation of `Equals`, `GetHashCode`, `ToString` and equality comparison via `==` and `!=`
 * Switch-Case/Map
 * Renaming of properties
@@ -583,3 +589,102 @@ textOrNumberFromString.Switch(text: s => logger.Information("[Switch] String Act
                               number: i => logger.Information("[Switch] Int Action: {Number}", i));
 ```
 
+## Regular unions
+
+Features:
+* Roslyn Analyzers and CodeFixes help the developers to implement the unions correctly
+* Can be a `class` or `record`
+* Switch-Case/Map
+* Supports generics
+* Derived types can be simple classes or something complex like a [value object](#value-objects).
+
+Simple union using a class and a value object:
+```csharp
+[Union]
+public partial class Animal
+{
+   [ValueObject<string>]
+   public partial class Dog : Animal;
+
+   public sealed class Cat : Animal;
+}
+
+```
+
+Similar example as above but with `records`:
+
+```csharp
+[Union]
+public partial record AnimalRecord
+{
+   public sealed record Dog(string Name) : AnimalRecord;
+
+   public sealed record Cat(string Name) : AnimalRecord;
+}
+```
+
+A union type (i.e. the base class) with a property:
+
+```csharp
+[Union]
+public partial class Animal
+{
+   public string Name { get; }
+
+   private Animal(string name)
+   {
+      Name = name;
+   }
+
+   public sealed class Dog(string Name) : Animal(Name);
+
+   public sealed class Cat(string Name) : Animal(Name);
+}
+```
+
+A `record` with a generic: 
+
+```csharp
+[Union]
+public partial record Result<T>
+{
+   public record Success(T Value) : Result<T>;
+
+   public record Failure(string Error) : Result<T>;
+
+   public static implicit operator Result<T>(T value) => new Success(value);
+   public static implicit operator Result<T>(string error) => new Failure(error);
+}
+```
+
+One of the main purposes for a regular union is their exhaustiveness, i.e. all member types are accounted for in a switch/map:
+
+```csharp
+Animal animal = new Animal.Dog("Milo");
+
+animal.Switch(dog: d => logger.Information("Dog: {Dog}", d),  
+              cat: c => logger.Information("Cat: {Cat}", c));
+
+var result = animal.Map(dog: "Dog",
+                        cat: "Cat");
+```
+
+Use flags `SwitchMethods` and `MapMethods` for generation of `SwitchPartially`/`MapPartially`:
+
+```csharp
+[Union(SwitchMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads,
+       MapMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads)]
+public partial record AnimalRecord
+{
+   public sealed record Dog(string Name) : AnimalRecord;
+
+   public sealed record Cat(string Name) : AnimalRecord;
+}
+
+---------------------------
+
+Animal animal = new Animal.Dog("Milo");
+
+animal.SwitchPartially(@default: a => logger.Information("Default: {Animal}", a),
+                       cat: c => logger.Information("Cat: {Cat}", c.Name));
+```

samples/Thinktecture.Runtime.Extensions.Samples/Program.cs

@@ -1,7 +1,7 @@
 using Serilog;
-using Thinktecture.DiscriminatedUnions;
 using Thinktecture.EmptyClass;
 using Thinktecture.SmartEnums;
+using Thinktecture.Unions;
 using Thinktecture.ValueObjects;
 
 namespace Thinktecture;

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/Animal.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/Animal.cs

@@ -1,4 +1,4 @@
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 [Union(SwitchMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads,
        MapMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads)]

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/AnimalRecord.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/AnimalRecord.cs

@@ -1,4 +1,4 @@
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 [Union(SwitchMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads,
        MapMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads)]

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/DiscriminatedUnionsDemos.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/DiscriminatedUnionsDemos.cs

@@ -1,6 +1,6 @@
 using Serilog;
 
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 public class DiscriminatedUnionsDemos
 {

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/Result.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/Result.cs

@@ -1,4 +1,4 @@
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 [Union(SwitchMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads,
        MapMethods = SwitchMapMethodsGeneration.DefaultWithPartialOverloads)]

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/TextOrNumber.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/TextOrNumber.cs

@@ -1,4 +1,4 @@
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 [Union<string, int>(T1IsNullableReferenceType = true,
                     T1Name = "Text",

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/TextOrNumberRefStruct.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/TextOrNumberRefStruct.cs

@@ -1,4 +1,4 @@
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 [Union<string, int>]
 public ref partial struct TextOrNumberRefStruct;

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/TextOrNumberStruct.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/TextOrNumberStruct.cs

@@ -1,4 +1,4 @@
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 [Union<string, int>]
 public partial struct TextOrNumberStruct;

samples/Thinktecture.Runtime.Extensions.Samples/DiscriminatedUnions/TextOrNumberWithAdditionalProperty.cs → samples/Thinktecture.Runtime.Extensions.Samples/Unions/TextOrNumberWithAdditionalProperty.cs

@@ -1,4 +1,4 @@
-namespace Thinktecture.DiscriminatedUnions;
+namespace Thinktecture.Unions;
 
 [Union<string, int>(T1Name = "Text",
                     T2Name = "Number",