Add direct bool comparisons to InterlockedFlag

Author: rdeago

CHANGELOG.md

@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `AsyncServiceSetupResult.Faulted` means that `SetupAsync` threw an exception.
 - Two new boolean properties in `AsyncHostedService` lets subclasses decide whether `StartAsync` should fail when the service is stopped before starting (`FailOnSetupNotStarted`) or `SetupAsync` completes with `false` (`FailOnSetupUnsuccessful`).  
 The default value is `true` for both properties.
+- Struct `Louis.Threading.InterlockedFlag` now implements `IEquatable<bool>`, as well as equality and inequality operators with `bool`.
 
 ### Changes to existing features
 

src/Louis/PublicAPI/net462/PublicAPI.Unshipped.txt

@@ -13,5 +13,8 @@ Louis.Threading.AsyncServiceSetupResult.Faulted = 4 -> Louis.Threading.AsyncServ
 Louis.Threading.AsyncServiceSetupResult.NotStarted = 1 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Successful = 0 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Unsuccessful = 2 -> Louis.Threading.AsyncServiceSetupResult
+Louis.Threading.InterlockedFlag.Equals(bool other) -> bool
+static Louis.Threading.InterlockedFlag.operator !=(Louis.Threading.InterlockedFlag a, bool b) -> bool
+static Louis.Threading.InterlockedFlag.operator ==(Louis.Threading.InterlockedFlag a, bool b) -> bool
 virtual Louis.Threading.AsyncService.LogSetupCompleted(bool success) -> void
 virtual Louis.Threading.AsyncService.SetupAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<bool>

src/Louis/PublicAPI/net47/PublicAPI.Unshipped.txt

@@ -13,5 +13,8 @@ Louis.Threading.AsyncServiceSetupResult.Faulted = 4 -> Louis.Threading.AsyncServ
 Louis.Threading.AsyncServiceSetupResult.NotStarted = 1 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Successful = 0 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Unsuccessful = 2 -> Louis.Threading.AsyncServiceSetupResult
+Louis.Threading.InterlockedFlag.Equals(bool other) -> bool
+static Louis.Threading.InterlockedFlag.operator !=(Louis.Threading.InterlockedFlag a, bool b) -> bool
+static Louis.Threading.InterlockedFlag.operator ==(Louis.Threading.InterlockedFlag a, bool b) -> bool
 virtual Louis.Threading.AsyncService.LogSetupCompleted(bool success) -> void
 virtual Louis.Threading.AsyncService.SetupAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<bool>

src/Louis/PublicAPI/net6.0/PublicAPI.Unshipped.txt

@@ -13,5 +13,8 @@ Louis.Threading.AsyncServiceSetupResult.Faulted = 4 -> Louis.Threading.AsyncServ
 Louis.Threading.AsyncServiceSetupResult.NotStarted = 1 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Successful = 0 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Unsuccessful = 2 -> Louis.Threading.AsyncServiceSetupResult
+Louis.Threading.InterlockedFlag.Equals(bool other) -> bool
+static Louis.Threading.InterlockedFlag.operator !=(Louis.Threading.InterlockedFlag a, bool b) -> bool
+static Louis.Threading.InterlockedFlag.operator ==(Louis.Threading.InterlockedFlag a, bool b) -> bool
 virtual Louis.Threading.AsyncService.LogSetupCompleted(bool success) -> void
 virtual Louis.Threading.AsyncService.SetupAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<bool>

src/Louis/PublicAPI/net7.0/PublicAPI.Unshipped.txt

@@ -14,7 +14,10 @@ Louis.Threading.AsyncServiceSetupResult.Faulted = 4 -> Louis.Threading.AsyncServ
 Louis.Threading.AsyncServiceSetupResult.NotStarted = 1 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Successful = 0 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Unsuccessful = 2 -> Louis.Threading.AsyncServiceSetupResult
+Louis.Threading.InterlockedFlag.Equals(bool other) -> bool
 static Louis.ComponentModel.SimpleStringConverter.AddToTypeDescriptor<T>() -> void
 Louis.Threading.AsyncService.StopAndWaitAsync() -> System.Threading.Tasks.Task<bool>!
+static Louis.Threading.InterlockedFlag.operator !=(Louis.Threading.InterlockedFlag a, bool b) -> bool
+static Louis.Threading.InterlockedFlag.operator ==(Louis.Threading.InterlockedFlag a, bool b) -> bool
 virtual Louis.Threading.AsyncService.LogSetupCompleted(bool success) -> void
 virtual Louis.Threading.AsyncService.SetupAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<bool>

src/Louis/PublicAPI/net8.0/PublicAPI.Unshipped.txt

@@ -14,7 +14,10 @@ Louis.Threading.AsyncServiceSetupResult.Faulted = 4 -> Louis.Threading.AsyncServ
 Louis.Threading.AsyncServiceSetupResult.NotStarted = 1 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Successful = 0 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Unsuccessful = 2 -> Louis.Threading.AsyncServiceSetupResult
+Louis.Threading.InterlockedFlag.Equals(bool other) -> bool
 static Louis.ComponentModel.SimpleStringConverter.AddToTypeDescriptor<T>() -> void
 Louis.Threading.AsyncService.StopAndWaitAsync() -> System.Threading.Tasks.Task<bool>!
+static Louis.Threading.InterlockedFlag.operator !=(Louis.Threading.InterlockedFlag a, bool b) -> bool
+static Louis.Threading.InterlockedFlag.operator ==(Louis.Threading.InterlockedFlag a, bool b) -> bool
 virtual Louis.Threading.AsyncService.LogSetupCompleted(bool success) -> void
 virtual Louis.Threading.AsyncService.SetupAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<bool>

src/Louis/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt

@@ -13,5 +13,8 @@ Louis.Threading.AsyncServiceSetupResult.Faulted = 4 -> Louis.Threading.AsyncServ
 Louis.Threading.AsyncServiceSetupResult.NotStarted = 1 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Successful = 0 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Unsuccessful = 2 -> Louis.Threading.AsyncServiceSetupResult
+Louis.Threading.InterlockedFlag.Equals(bool other) -> bool
+static Louis.Threading.InterlockedFlag.operator !=(Louis.Threading.InterlockedFlag a, bool b) -> bool
+static Louis.Threading.InterlockedFlag.operator ==(Louis.Threading.InterlockedFlag a, bool b) -> bool
 virtual Louis.Threading.AsyncService.LogSetupCompleted(bool success) -> void
 virtual Louis.Threading.AsyncService.SetupAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<bool>

src/Louis/PublicAPI/netstandard2.1/PublicAPI.Unshipped.txt

@@ -13,5 +13,8 @@ Louis.Threading.AsyncServiceSetupResult.Faulted = 4 -> Louis.Threading.AsyncServ
 Louis.Threading.AsyncServiceSetupResult.NotStarted = 1 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Successful = 0 -> Louis.Threading.AsyncServiceSetupResult
 Louis.Threading.AsyncServiceSetupResult.Unsuccessful = 2 -> Louis.Threading.AsyncServiceSetupResult
+Louis.Threading.InterlockedFlag.Equals(bool other) -> bool
+static Louis.Threading.InterlockedFlag.operator !=(Louis.Threading.InterlockedFlag a, bool b) -> bool
+static Louis.Threading.InterlockedFlag.operator ==(Louis.Threading.InterlockedFlag a, bool b) -> bool
 virtual Louis.Threading.AsyncService.LogSetupCompleted(bool success) -> void
 virtual Louis.Threading.AsyncService.SetupAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<bool>

src/Louis/Threading/InterlockedFlag.cs

@@ -9,7 +9,7 @@ namespace Louis.Threading;
 /// <summary>
 /// Implements thread-safe management of a boolean value.
 /// </summary>
-public struct InterlockedFlag : IEquatable<InterlockedFlag>
+public struct InterlockedFlag : IEquatable<InterlockedFlag>, IEquatable<bool>
 {
     private int _value;
 
@@ -53,12 +53,37 @@ public bool Value
     /// otherwise, <see langword="false"/>.</returns>
     public static bool operator !=(InterlockedFlag a, InterlockedFlag b) => a.Value != b.Value;
 
+    /// <summary>
+    /// Determines whether a specified interlocked flag has the specified value.
+    /// </summary>
+    /// <param name="a">The interlocked flag to compare.</param>
+    /// <param name="b">The value to compare.</param>
+    /// <returns><see langword="true"/> if the value of <paramref name="a"/> is the same as <paramref name="b"/>;
+    /// otherwise, <see langword="false"/>.</returns>
+    public static bool operator ==(InterlockedFlag a, bool b) => a.Value == b;
+
+    /// <summary>
+    /// Determines whether a specified interlocked flags has a value different from a specified value.
+    /// </summary>
+    /// <param name="a">The interlocked flag to compare.</param>
+    /// <param name="b">The value to compare.</param>
+    /// <returns><see langword="true"/> if the value of <paramref name="a"/> is different from <paramref name="b"/>;
+    /// otherwise, <see langword="false"/>.</returns>
+    public static bool operator !=(InterlockedFlag a, bool b) => a.Value != b;
+
     /// <inheritdoc/>
-    public override bool Equals(object? obj) => obj is InterlockedFlag other && Equals(other);
+    public override bool Equals(object? obj) => obj switch {
+        bool value => value == Value,
+        InterlockedFlag other => other.Value == Value,
+        _ => false,
+    };
 
     /// <inheritdoc/>
     public bool Equals(InterlockedFlag other) => other.Value == Value;
 
+    /// <inheritdoc/>
+    public bool Equals(bool other) => other == Value;
+
     /// <inheritdoc/>
     public override int GetHashCode() => Value.GetHashCode();