Struct InterlockedBoolean

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

A lightweight representation of an Interlocked (atomic) bool.

public struct InterlockedBoolean : IEquatable<InterlockedBoolean>, IComparable<InterlockedBoolean>, IComparable

Implements

IEquatable<InterlockedBoolean>

IComparable<InterlockedBoolean>

IComparable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ObjectExtensions.Max<T>(T, T)

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.MinMax<T>(T, T)

ObjectExtensions.Min<T>(T, T)

ObjectExtensions.ToNullable<T>(T)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

Constructors

InterlockedBoolean(bool)

Creates a new InterlockedBoolean instance.

public InterlockedBoolean(bool value)

Parameters

value bool

Initial value.

Properties

Value

Current value.

public bool Value { get; }

Property Value

bool

Methods

CompareTo(InterlockedBoolean)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

[Pure]
public int CompareTo(InterlockedBoolean other)

Parameters

other InterlockedBoolean

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

CompareTo(object?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

[Pure]
public int CompareTo(object? obj)

Parameters

obj object

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes obj in the sort order.
Zero	This instance occurs in the same position in the sort order as obj.
Greater than zero	This instance follows obj in the sort order.

Exceptions

ArgumentException

obj is not the same type as this instance.

Equals(InterlockedBoolean)

Indicates whether the current object is equal to another object of the same type.

[Pure]
public bool Equals(InterlockedBoolean other)

Parameters

other InterlockedBoolean

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

[Pure]
public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

[Pure]
public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns a string representation of this InterlockedBoolean instance.

[Pure]
public override string ToString()

Returns

string

String representation.

Toggle()

Toggles (negates) the current Value.

public bool Toggle()

Returns

bool

Value after change.

Write(bool)

Sets Value to the provided value.

public bool Write(bool value)

Parameters

value bool

Value to set.

Returns

bool

true when value has changed, otherwise false.

WriteFalse()

Sets Value to false.

public bool WriteFalse()

Returns

bool

true when value has changed, otherwise false.

WriteTrue()

Sets Value to true.

public bool WriteTrue()

Returns

bool

true when value has changed, otherwise false.

Operators

operator ==(InterlockedBoolean, InterlockedBoolean)

Checks if a is equal to b.

public static bool operator ==(InterlockedBoolean a, InterlockedBoolean b)

Parameters

a InterlockedBoolean

First operand.

b InterlockedBoolean

Second operand.

Returns

bool

true when operands are equal, otherwise false.

operator >(InterlockedBoolean, InterlockedBoolean)

Checks if a is greater than b.

public static bool operator >(InterlockedBoolean a, InterlockedBoolean b)

Parameters

a InterlockedBoolean

First operand.

b InterlockedBoolean

Second operand.

Returns

bool

true when a is greater than b, otherwise false.

operator >=(InterlockedBoolean, InterlockedBoolean)

Checks if a is greater than or equal to b.

public static bool operator >=(InterlockedBoolean a, InterlockedBoolean b)

Parameters

a InterlockedBoolean

First operand.

b InterlockedBoolean

Second operand.

Returns

bool

true when a is greater than or equal to b, otherwise false.

operator !=(InterlockedBoolean, InterlockedBoolean)

Checks if a is not equal to b.

public static bool operator !=(InterlockedBoolean a, InterlockedBoolean b)

Parameters

a InterlockedBoolean

First operand.

b InterlockedBoolean

Second operand.

Returns

bool

true when operands are not equal, otherwise false.

operator <(InterlockedBoolean, InterlockedBoolean)

Checks if a is less than b.

public static bool operator <(InterlockedBoolean a, InterlockedBoolean b)

Parameters

a InterlockedBoolean

First operand.

b InterlockedBoolean

Second operand.

Returns

bool

true when a is less than b, otherwise false.

operator <=(InterlockedBoolean, InterlockedBoolean)

Checks if a is less than or equal to b.

public static bool operator <=(InterlockedBoolean a, InterlockedBoolean b)

Parameters

a InterlockedBoolean

First operand.

b InterlockedBoolean

Second operand.

Returns

bool

true when a is less than or equal to b, otherwise false.