Skip to content

Add workaround and missing [MemberNotNullWhen] attributes #1879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisPulman merged 4 commits into from
Oct 17, 2024
Merged

Add workaround and missing [MemberNotNullWhen] attributes #1879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cdda753
Add workaround and missing MemberNotNullWhen attributes
sguryev Oct 14, 2024
d66a284
Merge branch 'main' into serj/main-member-not-null-when
ChrisPulman Oct 16, 2024
b464f29
Merge branch 'main' into serj/main-member-not-null-when
ChrisPulman Oct 16, 2024
2a85c2c
Fix API Tests
ChrisPulman Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Refit.Tests/API/ApiApprovalTests.Refit.DotNet6_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
9 changes: 9 additions & 0 deletions Refit.Tests/API/ApiApprovalTests.Refit.DotNet8_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
25 changes: 25 additions & 0 deletions Refit/ApiResponse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down