Improve exceptions details for GetUnsafe methods on monads (#372)

* Add NoneStateException for Maybe<T>

* Use explicit exceptions for GetUnsafe methods on Result

* Fix typos in Xml Docs

* Comply to ISerializable implementation

* Add missing Serializable attribute

Vonage.Common.Test/Monads/MaybeTest.cs

@@ -1,5 +1,6 @@
 using FluentAssertions;
 using Vonage.Common.Monads;
+using Vonage.Common.Monads.Exceptions;
 using Vonage.Common.Test.Extensions;
 
 namespace Vonage.Common.Test.Monads
@@ -69,7 +70,7 @@ public void GetUnsafe_ShouldReturnValue_GivenSome<T>(T value) =>
         public void GetUnsafe_ShouldThrowException_GivenNone()
         {
             Action act = () => Maybe<string>.None.GetUnsafe();
-            act.Should().Throw<UnsafeValueException>().WithMessage("State is None.");
+            act.Should().Throw<NoneStateException>();
         }
 
         [Fact]

Vonage.Common.Test/Monads/ResultTest.cs

@@ -1,6 +1,7 @@
 using FluentAssertions;
 using Vonage.Common.Failures;
 using Vonage.Common.Monads;
+using Vonage.Common.Monads.Exceptions;
 using Vonage.Common.Test.Extensions;
 
 namespace Vonage.Common.Test.Monads
@@ -112,7 +113,8 @@ public void GetFailureUnsafe_ShouldReturnFailure_GivenFailure() =>
         public void GetFailureUnsafe_ShouldThrowException_GivenSuccess()
         {
             Action act = () => CreateSuccess(5).GetFailureUnsafe();
-            act.Should().Throw<UnsafeValueException>().WithMessage("State is Success.");
+            act.Should().Throw<SuccessStateException<int>>().WithMessage("State is Success.")
+                .Which.Success.Should().Be(5);
         }
 
         [Fact]
@@ -137,7 +139,9 @@ public void GetSuccessUnsafe_ShouldReturn_GivenSuccess() =>
         public void GetSuccessUnsafe_ShouldThrowException_GivenFailure()
         {
             Action act = () => CreateFailure().GetSuccessUnsafe();
-            act.Should().Throw<UnsafeValueException>().WithMessage("State is Failure.");
+            act.Should().Throw<FailureStateException>()
+                .WithMessage("State is Failure.")
+                .Which.Failure.Should().Be(CreateResultFailure());
         }
 
         [Fact]

Vonage.Common/Monads/Exceptions/FailureStateException.cs

@@ -0,0 +1,24 @@
+using System;
+using Vonage.Common.Failures;
+
+namespace Vonage.Common.Monads.Exceptions;
+
+/// <summary>
+///     Represents errors that occurs when a Result is in a Failure state.
+/// </summary>
+[Serializable]
+public class FailureStateException : Exception
+{
+    /// <summary>
+    ///     Gets the failure value of the Result.
+    /// </summary>
+    public IResultFailure Failure { get; }
+
+    /// <summary>
+    ///     Creates a FailureStateException.
+    /// </summary>
+    /// <param name="failure">The failure value of the Result.</param>
+    public FailureStateException(IResultFailure failure)
+        : base("State is Failure.") =>
+        this.Failure = failure;
+}

Vonage.Common/Monads/Exceptions/NoneStateException.cs

@@ -0,0 +1,18 @@
+using System;
+
+namespace Vonage.Common.Monads.Exceptions;
+
+/// <summary>
+///     Represents errors that occurs when a Maybe is in a None state.
+/// </summary>
+[Serializable]
+public class NoneStateException : Exception
+{
+    /// <summary>
+    ///     Creates a NoneStateException.
+    /// </summary>
+    public NoneStateException()
+        : base("State is None.")
+    {
+    }
+}

Vonage.Common/Monads/Exceptions/SuccessStateException.cs

@@ -0,0 +1,23 @@
+using System;
+
+namespace Vonage.Common.Monads.Exceptions;
+
+/// <summary>
+///     Represents errors that occurs when a Result is in a Success state.
+/// </summary>
+[Serializable]
+public class SuccessStateException<T> : Exception
+{
+    /// <summary>
+    ///     Gets the success value of the Result.
+    /// </summary>
+    public T Success { get; }
+
+    /// <summary>
+    ///     Creates a SuccessStateException.
+    /// </summary>
+    /// <param name="success">The success value of the Result.</param>
+    public SuccessStateException(T success)
+        : base("State is Success.") =>
+        this.Success = success;
+}

Vonage.Common/Monads/Maybe.cs

@@ -1,4 +1,5 @@
 using System;
+using Vonage.Common.Monads.Exceptions;
 
 namespace Vonage.Common.Monads;
 
@@ -58,8 +59,8 @@ private Maybe(TA value)
     ///     Retrieves the Maybe's value. This method is unsafe and will throw an exception if in None state.
     /// </summary>
     /// <returns>The value if in Some state.</returns>
-    /// <exception cref="UnsafeValueException">When in None state.</exception>
-    public TA GetUnsafe() => this.IfNone(() => throw new UnsafeValueException("State is none."));
+    /// <exception cref="NoneStateException">When in None state.</exception>
+    public TA GetUnsafe() => this.IfNone(() => throw new NoneStateException());
 
     /// <summary>
     ///     Returns the result of the operation if Maybe is in the None state, the Some value otherwise.

Vonage.Common/Monads/Result.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Threading.Tasks;
 using Vonage.Common.Failures;
+using Vonage.Common.Monads.Exceptions;
 
 namespace Vonage.Common.Monads;
 
@@ -85,9 +86,9 @@ public async Task<Result<TB>> BindAsync<TB>(Func<T, Task<Result<TB>>> bind) =>
     ///     Retrieves the Failure value. This method is unsafe and will throw an exception if in Success state.
     /// </summary>
     /// <returns>The Failure value when in Failure state.</returns>
-    /// <exception cref="UnsafeValueException">When in Success state.</exception>
+    /// <exception cref="FailureStateException">When in Success state.</exception>
     public IResultFailure GetFailureUnsafe() =>
-        this.Match(_ => throw new UnsafeValueException("State is Success."), _ => _);
+        this.Match(value => throw new SuccessStateException<T>(value), _ => _);
 
     /// <inheritdoc />
     public override int GetHashCode() => this.IsSuccess ? this.success.GetHashCode() : this.failure.GetHashCode();
@@ -96,8 +97,8 @@ public IResultFailure GetFailureUnsafe() =>
     ///     Retrieves the Success value. This method is unsafe and will throw an exception if in Failure state.
     /// </summary>
     /// <returns>The Success value if in Success state.</returns>
-    /// <exception cref="UnsafeValueException">When in Failure state.</exception>
-    public T GetSuccessUnsafe() => this.Match(_ => _, _ => throw new UnsafeValueException("State is Failure."));
+    /// <exception cref="FailureStateException">When in Failure state.</exception>
+    public T GetSuccessUnsafe() => this.IfFailure(value => throw new FailureStateException(value));
 
     /// <summary>
     ///     Invokes the action if Result is in the Failure state, otherwise nothing happens.