Skip to content

Added [NotNullWhen(true)] for Entity IsOn & IsOff extension methods #856

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
Apr 5, 2023
Merged

Added [NotNullWhen(true)] for Entity IsOn & IsOff extension methods #856

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
10 changes: 5 additions & 5 deletions src/HassModel/NetDeamon.HassModel/Entities/EntityExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,28 @@ public static class EntityExtensions
/// </summary>
/// <param name="entityState">The state to check</param>
/// <returns>true if the state equals "on", otherwise false</returns>
public static bool IsOn(this EntityState? entityState) => string.Equals(entityState?.State, "on", StringComparison.OrdinalIgnoreCase);
public static bool IsOn([NotNullWhen(true)] this EntityState? entityState) => string.Equals(entityState?.State, "on", StringComparison.OrdinalIgnoreCase);

/// <summary>
/// Checks if an EntityState has the state "off"
/// </summary>
/// <param name="entityState">The state to check</param>
/// <returns>true if the state equals "off", otherwise false</returns>
public static bool IsOff(this EntityState? entityState) => string.Equals(entityState?.State, "off", StringComparison.OrdinalIgnoreCase);
public static bool IsOff([NotNullWhen(true)] this EntityState? entityState) => string.Equals(entityState?.State, "off", StringComparison.OrdinalIgnoreCase);

/// <summary>
/// Checks if an Entity has the state "on"
/// </summary>
/// <param name="entity">The state to check</param>
/// <returns>true if the state equals "on", otherwise false</returns>
public static bool IsOn(this Entity? entity) => entity?.EntityState?.IsOn() ?? false;
public static bool IsOn([NotNullWhen(true)] this Entity? entity) => entity?.EntityState?.IsOn() ?? false;

/// <summary>
/// Checks if an Entity has the state "off"
/// </summary>
/// <param name="entity">The state to check</param>
/// <returns>true if the state equals "off", otherwise false</returns>
public static bool IsOff(this Entity? entity) => entity?.EntityState?.IsOff() ?? false;
public static bool IsOff([NotNullWhen(true)] this Entity? entity) => entity?.EntityState?.IsOff() ?? false;

/// <summary>Gets a NumericEntity from a given Entity</summary>
public static NumericEntity AsNumeric(this Entity entity) => new(entity);
Expand All @@ -56,4 +56,4 @@ public static NumericEntity<TAttributes> WithAttributesAs<TAttributes>(this Nume

internal static IObservable<T> StateChangesOnly<T>(this IObservable<T> changes) where T : StateChange
=> changes.Where(c => c.New?.State != c.Old?.State);
}
}