0.1.3 (#2)

* Add Fallible.Void type to specify a return type which returns nothing but can contain an error.

Fallible.Void can only be created using the Fallible.Return property.

* Add Fallible.Void type to specify a return type which returns nothing but can contain an error.

Fallible.Void can only be created using the Fallible.Return property.

Fallible.Tests/FallibleTests.cs

@@ -16,7 +16,7 @@ public void WhenCreated_ContainsError()
 
         Assert.Equal(error, fallible.Error);
     }
-    
+
     [Fact]
     public void WhenCreated_ContainsDefaultValue_WhenValueType()
     {
@@ -75,6 +75,16 @@ public void CanBeDeconstructed_ValueIsExpected()
         Assert.Equal(expectedValue, value);
     }
 
+    [Fact]
+    public void CanBeDeconstructed_ShouldHaveNullResult_WhenVoidReturn()
+    {
+        Fallible<Void> fallible = new Error("Wrong Number");
+
+        var (result, _) = fallible;
+
+        Assert.Null(result);
+    }
+
     #endregion
 
     #region Conversion Tests
@@ -123,6 +133,17 @@ public void CanBeImplicitlyConverted_FromTuple_WhenValueIsNull()
         Assert.IsType<Fallible<object>>(fallible);
     }
 
+    [Fact]
+    public void CanBeImplicitlyConverted_FromVoid_WhenReturning()
+    {
+        var func = Fallible<Void>() => Fallible.Return;
+
+        Fallible<Void> fallible = func();
+
+        Assert.IsType<Fallible<Void>>(fallible);
+
+    }
+
     #endregion
 
     #region Static Method Tests

Fallible/Fallible.csproj

@@ -5,7 +5,7 @@
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <PackageVersion>0.1.2</PackageVersion>
+        <PackageVersion>0.1.3</PackageVersion>
         <Title>Fallible</Title>
         <Authors>Tom van Dinther</Authors>
         <Description>An idiomatic way to explicitly define, propagate and handle error states in C#. This library is inspired by Go's errors.</Description>

Fallible/Fallible.cs → Fallible/FallibleGenericStruct.cs

@@ -4,8 +4,6 @@
 
 namespace Fallible;
 
-#region Generic Struct
-
 public readonly record struct Fallible<T> : IStructuralEquatable, ITuple
 {
     public T Value { get; }
@@ -17,7 +15,11 @@ private Fallible(T value, Error error)
         Error = error;
     }
 
-    public static implicit operator Fallible<T>(Error error) => new(default!, error);
+    public static implicit operator Fallible<T>(Error error)
+    {
+        return new(default!, error);
+    }
+
     public static implicit operator Fallible<T>(T value) => new(value, default!);
     public static implicit operator Fallible<T>((T? value, Error? error) tuple) => new(tuple.value!, tuple.error!);
 
@@ -49,25 +51,3 @@ public int GetHashCode(IEqualityComparer comparer)
 
     public int Length => 2;
 }
-
-#endregion
-
-#region Static Class
-
-public static class Fallible
-{
-    public static Fallible<TResult> Try<TResult>(Func<TResult> action, [CallerArgumentExpression("action")] string expression = "")
-    {
-        try
-        {
-            var value = action();
-            return value;
-        }
-        catch (Exception e)
-        {
-            return new Error($"{expression} threw {e.GetType().Name}: {e.Message}");
-        }
-    }
-}
-
-#endregion

Fallible/FallibleStatic.cs

@@ -0,0 +1,21 @@
+using System.Runtime.CompilerServices;
+
+namespace Fallible;
+
+public static class Fallible
+{
+    public static Fallible<TResult> Try<TResult>(Func<TResult> action, [CallerArgumentExpression("action")] string expression = "")
+    {
+        try
+        {
+            var value = action();
+            return value;
+        }
+        catch (Exception e)
+        {
+            return new Error($"{expression} threw {e.GetType().Name}: {e.Message}");
+        }
+    }
+
+    public static Fallible<Void> Return => new Void();
+}

Fallible/Void.cs

@@ -0,0 +1,6 @@
+namespace Fallible;
+
+public class Void
+{
+    internal Void() { }
+}

README.md

@@ -96,6 +96,20 @@ public Fallible<int> GetValue(int arg)
 }
 ```
 
+#### Returning `void`
+
+Fallible includes a `void` type that can be used to return *void* from a method. It does not have an accessible constructor and can only be created by using the `Fallible.Return` property.
+
+```c#
+public Fallible<Void> DoSomething()
+{
+    // Do something
+    if (somethingFailed) return new Error("Something went wrong");
+
+    return Fallible.Return;
+}
+```
+
 ### Working with `Fallible<T>`
 
 When working with a `Fallible<T>` type returned by a method, it is best to deconstruct it upon assignment and then perform a check on the error state. `Error` contains an implicit boolean conversion operator that returns `true` if the error state is not `null`.