feat(monad): expose helper types for empty results (#23)

draekien · Jun 19, 2024 · a2ed67a · a2ed67a
1 parent 7a3a545
commit a2ed67a
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 5 deletions.
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -11,6 +11,6 @@
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
     </PropertyGroup>
     <ItemGroup>
-        <PackageReference Include="JetBrains.Annotations" Version="2022.3.1"/>
+        <PackageReference Include="JetBrains.Annotations" Version="2022.3.1" PrivateAssets="All"/>
     </ItemGroup>
 </Project>
diff --git a/src/FluentUtils.Monad/ErrorResultType.cs b/src/FluentUtils.Monad/ErrorResultType.cs
@@ -1,4 +1,12 @@
-namespace FluentUtils.Monad;
+using JetBrains.Annotations;
+
+namespace FluentUtils.Monad;
+
+/// <summary>
+///     An <see cref="ErrorResultType{T}"/> for a result which would have returned an <see cref="Empty"/> value
+/// </summary>
+/// <param name="Error">The <see cref="Error"/></param>
+public record ErrorResultType(Error Error) : ErrorResultType<Empty>(Error);
 
 /// <summary>
 ///     The <see cref="ResultType{T}" /> variant that represents an error and containing an <see cref="Error" /> value
@@ -7,7 +15,8 @@
 ///     Do not access this record directly - invoke the <c>Unwrap</c> or <c>Match</c> extension methods instead
 /// </remarks>
 /// <typeparam name="T">The value type associated with it's <see cref="OkResultType{T}" /> counterpart</typeparam>
-public sealed record ErrorResultType<T> : ResultType<T> where T : notnull
+[PublicAPI]
+public record ErrorResultType<T> : ResultType<T> where T : notnull
 {
     internal ErrorResultType(Error error)
     {

diff --git a/src/FluentUtils.Monad/OkResultType.cs b/src/FluentUtils.Monad/OkResultType.cs
@@ -1,4 +1,12 @@
-namespace FluentUtils.Monad;
+using JetBrains.Annotations;
+
+namespace FluentUtils.Monad;
+
+/// <summary>
+///     An <see cref="OkResultType{T}" /> that contains an <see cref="Empty" /> value
+/// </summary>
+[PublicAPI]
+public record OkResultType() : OkResultType<Empty>(new Empty());
 
 /// <summary>
 ///     The <see cref="ResultType{T}" /> variant that represents a success and contains a value
@@ -7,7 +15,8 @@
 ///     Do not access this record directly - invoke the <c>Unwrap</c> or <c>Match</c> extension methods instead
 /// </remarks>
 /// <typeparam name="T">The value type</typeparam>
-public sealed record OkResultType<T> : ResultType<T> where T : notnull
+[PublicAPI]
+public record OkResultType<T> : ResultType<T> where T : notnull
 {
     /// <summary>
     ///     Do not use directly

diff --git a/src/FluentUtils.Monad/ResultType.cs b/src/FluentUtils.Monad/ResultType.cs
@@ -2,6 +2,12 @@
 
 namespace FluentUtils.Monad;
 
+/// <summary>
+///     A <see cref="ResultType{T}" /> that contains an <see cref="Empty" /> value.
+/// </summary>
+[PublicAPI]
+public abstract record ResultType : ResultType<Empty>;
+
 /// <summary>
 ///     The result monad
 /// </summary>