Add entity interface for parity.

pobiega · May 5, 2023 · 806de47 · 806de47
1 parent fd7064a
commit 806de47
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/Remora.Results/IResult.cs b/Remora.Results/IResult.cs
@@ -25,8 +25,10 @@
 
 namespace Remora.Results;
 
+#pragma warning disable SA1402
+
 /// <summary>
-/// Represents the public API of an interface.
+/// Represents the public API of a result.
 /// </summary>
 [PublicAPI]
 public interface IResult
@@ -47,3 +49,17 @@ public interface IResult
     /// </summary>
     IResult? Inner { get; }
 }
+
+/// <summary>
+/// Represents the public API of a result with a contained value.
+/// </summary>
+/// <typeparam name="TEntity">The type of the contained value.</typeparam>
+[PublicAPI]
+public interface IResult<out TEntity> : IResult
+{
+    /// <summary>
+    /// Gets the entity returned by the result.
+    /// </summary>
+    [AllowNull]
+    TEntity Entity { get; }
+}
diff --git a/Remora.Results/Result.cs b/Remora.Results/Result.cs
@@ -167,7 +167,7 @@ public static implicit operator Result(Exception exception)
 
 /// <inheritdoc />
 [PublicAPI]
-public readonly struct Result<TEntity> : IResult
+public readonly struct Result<TEntity> : IResult<TEntity>
 {
     /// <summary>
     /// Gets the entity returned by the result.