Skip to content

🚨 Improve nullable reference type annotations on OptionalValue GetSpecifiedValueOrDefault() #20

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
merged 1 commit into from
Sep 3, 2025
Merged

🚨 Improve nullable reference type annotations on OptionalValue GetSpecifiedValueOrDefault() #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions src/OptionalValues/OptionalValue.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public OptionalValue(T value)
/// <returns>
/// The specified value or the default value of <typeparamref name="T"/>.
/// </returns>
public T GetSpecifiedValueOrDefault() => GetSpecifiedValueOrDefault(default!);
public T? GetSpecifiedValueOrDefault() => GetSpecifiedValueOrDefault(default);

/// <summary>
/// Gets the specified value or the provided default value.
Expand All @@ -64,7 +64,8 @@ public OptionalValue(T value)
/// <returns>
/// The specified value or the <paramref name="defaultValue"/>.
/// </returns>
public T GetSpecifiedValueOrDefault(T defaultValue) => IsSpecified ? Value! : defaultValue;
[return: NotNullIfNotNull(nameof(defaultValue))]
public T? GetSpecifiedValueOrDefault(T? defaultValue) => IsSpecified ? Value! : defaultValue;

/// <summary>
/// Creates an Unspecified OptionalValue. This will have <see cref="IsSpecified"/> set to <c>false</c>.
Expand Down
6 changes: 3 additions & 3 deletions src/OptionalValues/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ OptionalValues.Extensions.DictionaryExtensions
OptionalValues.OptionalValue
OptionalValues.OptionalValue<T>
OptionalValues.OptionalValue<T>.Equals(OptionalValues.OptionalValue<T> other) -> bool
OptionalValues.OptionalValue<T>.GetSpecifiedValueOrDefault() -> T
OptionalValues.OptionalValue<T>.GetSpecifiedValueOrDefault(T defaultValue) -> T
OptionalValues.OptionalValue<T>.GetSpecifiedValueOrDefault() -> T?
OptionalValues.OptionalValue<T>.GetSpecifiedValueOrDefault(T? defaultValue) -> T?
OptionalValues.OptionalValue<T>.IsSpecified.get -> bool
OptionalValues.OptionalValue<T>.OptionalValue() -> void
OptionalValues.OptionalValue<T>.OptionalValue(T value) -> void
Expand All @@ -29,11 +29,11 @@ static OptionalValues.Extensions.DictionaryExtensions.SetOptionalValue<TKey, T>(
static OptionalValues.Extensions.DictionaryExtensions.TryAddOptionalValue<TKey, T>(this System.Collections.Generic.IDictionary<TKey, T>! dictionary, TKey key, OptionalValues.OptionalValue<T> value) -> bool
static OptionalValues.OptionalValue.GetUnderlyingType(System.Type! optionalValueType) -> System.Type!
static OptionalValues.OptionalValue.IsOptionalValueType(System.Type! type) -> bool
static OptionalValues.OptionalValue<T>.Unspecified.get -> OptionalValues.OptionalValue<T>
static OptionalValues.OptionalValue<T>.implicit operator OptionalValues.OptionalValue<T>(T value) -> OptionalValues.OptionalValue<T>
static OptionalValues.OptionalValue<T>.implicit operator T?(OptionalValues.OptionalValue<T> value) -> T?
static OptionalValues.OptionalValue<T>.operator !=(OptionalValues.OptionalValue<T> left, OptionalValues.OptionalValue<T> right) -> bool
static OptionalValues.OptionalValue<T>.operator ==(OptionalValues.OptionalValue<T> left, OptionalValues.OptionalValue<T> right) -> bool
static OptionalValues.OptionalValue<T>.Unspecified.get -> OptionalValues.OptionalValue<T>
static OptionalValues.OptionalValueJsonExtensions.AddOptionalValueSupport(this System.Text.Json.JsonSerializerOptions! options) -> System.Text.Json.JsonSerializerOptions!
static OptionalValues.OptionalValueJsonExtensions.WithOptionalValueSupport(this System.Text.Json.JsonSerializerOptions! options) -> System.Text.Json.JsonSerializerOptions!
virtual OptionalValues.OptionalValueJsonConverterAttribute.CreateInnerConverter() -> System.Text.Json.Serialization.JsonConverter!
9 changes: 9 additions & 0 deletions test/OptionalValues.Tests/OptionalValueTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,5 +333,14 @@ public void Should_Be_Value_Even_When_Null()

sut.GetSpecifiedValueOrDefault("Default").ShouldBe(null);
}

[Fact]
public void Allows_Null_Default()
{
OptionalValue<string> sut = default;

var nullDefault = sut.GetSpecifiedValueOrDefault(null);
nullDefault.ShouldBeNull();
}
}
}