Add workaround and missing [MemberNotNullWhen] attributes (#1879)

* Add workaround and missing MemberNotNullWhen attributes * Fix API Tests --------- Co-authored-by: Chris Pulman <chris.pulman@yahoo.com>
reactiveui · Oct 17, 2024 · b13cbf2 · b13cbf2
1 parent 396c2bf
commit b13cbf2
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/Refit.Tests/API/ApiApprovalTests.Refit.DotNet6_0.verified.txt b/Refit.Tests/API/ApiApprovalTests.Refit.DotNet6_0.verified.txt
@@ -198,6 +198,15 @@ namespace Refit
     public interface IApiResponse<out T> : Refit.IApiResponse, System.IDisposable
     {
         T Content { get; }
+        new System.Net.Http.Headers.HttpContentHeaders? ContentHeaders { get; }
+        new Refit.ApiException? Error { get; }
+        [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(false, "Error")]
+        [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Content")]
+        [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "ContentHeaders")]
+        [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(false, "Error")]
+        [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Content")]
+        [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "ContentHeaders")]
+        new bool IsSuccessStatusCode { get; }
     }
     public interface IFormUrlEncodedParameterFormatter
     {

diff --git a/Refit.Tests/API/ApiApprovalTests.Refit.DotNet8_0.verified.txt b/Refit.Tests/API/ApiApprovalTests.Refit.DotNet8_0.verified.txt
@@ -198,6 +198,15 @@ namespace Refit
     public interface IApiResponse<out T> : Refit.IApiResponse, System.IDisposable
     {
         T Content { get; }
+        new System.Net.Http.Headers.HttpContentHeaders? ContentHeaders { get; }
+        new Refit.ApiException? Error { get; }
+        [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(false, "Error")]
+        [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Content")]
+        [System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "ContentHeaders")]
+        [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(false, "Error")]
+        [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "Content")]
+        [get: System.Diagnostics.CodeAnalysis.MemberNotNullWhen(true, "ContentHeaders")]
+        new bool IsSuccessStatusCode { get; }
     }
     public interface IFormUrlEncodedParameterFormatter
     {

diff --git a/Refit/ApiResponse.cs b/Refit/ApiResponse.cs
@@ -152,6 +152,31 @@ void Dispose(bool disposing)
     /// <inheritdoc/>
     public interface IApiResponse<out T> : IApiResponse
     {
+#if NET6_0_OR_GREATER
+        /// <summary>
+        /// The <see cref="ApiException"/> object in case of unsuccessful response.
+        /// </summary>
+        [SuppressMessage(
+            "Naming",
+            "CA1716:Identifiers should not match keywords",
+            Justification = "By Design"
+        )]
+        new ApiException? Error { get; }
+
+        /// <summary>
+        /// HTTP response content headers as defined in RFC 2616.
+        /// </summary>
+        new HttpContentHeaders? ContentHeaders { get; }
+
+        /// <summary>
+        /// Indicates whether the request was successful.
+        /// </summary>
+        [MemberNotNullWhen(true, nameof(Content))]
+        [MemberNotNullWhen(true, nameof(ContentHeaders))]
+        [MemberNotNullWhen(false, nameof(Error))]
+        new bool IsSuccessStatusCode { get; }
+#endif
+
         /// <summary>
         /// Deserialized request content as <typeparamref name="T"/>.
         /// </summary>