Struct InterlockedInt32

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

A lightweight representation of an Interlocked (atomic) int.

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

Implements

IEquatable<InterlockedInt32>

IComparable<InterlockedInt32>

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

InterlockedInt32(int)

Creates a new InterlockedInt32 instance.

public InterlockedInt32(int value)

Parameters

value int

Initial value.

Properties

Value

Current value.

public int Value { get; }

Property Value

int

Methods

Add(int)

Adds provided value to the current Value.

public int Add(int value)

Parameters

value int

Value to add.

Returns

int

Value after the change.

And(int)

Performs a bitwise and operation on the current Value and the provided value and stores the result in Value.

public int And(int value)

Parameters

value int

Value to bitwise and.

Returns

int

Value before the change.

CompareExchange(int, int)

Sets Value to the provided value only if the current Value is equal to the provided comparand and returns the old value.

public int CompareExchange(int value, int comparand)

Parameters

value int

Value to set.

comparand int

Value used for Value comparison.

Returns

int

Value before the change.

CompareTo(InterlockedInt32)

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(InterlockedInt32 other)

Parameters

other InterlockedInt32

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.

Decrement()

Decrements the current Value by 1.

public int Decrement()

Returns

int

Value after the change.

Equals(InterlockedInt32)

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

[Pure]
public bool Equals(InterlockedInt32 other)

Parameters

other InterlockedInt32

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.

Exchange(int)

Sets Value to the provided value and returns the old value.

public int Exchange(int value)

Parameters

value int

Value to set.

Returns

int

Value before the change.

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.

Increment()

Increments the current Value by 1.

public int Increment()

Returns

int

Value after the change.

Or(int)

Performs a bitwise or operation on the current Value and the provided value and stores the result in Value.

public int Or(int value)

Parameters

value int

Value to bitwise or.

Returns

int

Value before the change.

Subtract(int)

Subtracts provided value from the current Value.

public int Subtract(int value)

Parameters

value int

Value to subtract.

Returns

int

Value after the change.

ToString()

Returns a string representation of this InterlockedInt32 instance.

[Pure]
public override string ToString()

Returns

string

String representation.

Write(int)

Sets Value to the provided value.

public bool Write(int value)

Parameters

value int

Value to set.

Returns

bool

true when value has changed, otherwise false.

Write(int, int)

Sets Value to the provided value only if the current Value is equal to the provided expected.

public bool Write(int value, int expected)

Parameters

value int

Value to set.

expected int

Value used for Value comparison.

Returns

bool

true when value has changed, otherwise false.

Operators

operator ==(InterlockedInt32, InterlockedInt32)

Checks if a is equal to b.

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

Parameters

a InterlockedInt32

First operand.

b InterlockedInt32

Second operand.

Returns

bool

true when operands are equal, otherwise false.

operator >(InterlockedInt32, InterlockedInt32)

Checks if a is greater than b.

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

Parameters

a InterlockedInt32

First operand.

b InterlockedInt32

Second operand.

Returns

bool

true when a is greater than b, otherwise false.

operator >=(InterlockedInt32, InterlockedInt32)

Checks if a is greater than or equal to b.

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

Parameters

a InterlockedInt32

First operand.

b InterlockedInt32

Second operand.

Returns

bool

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

operator !=(InterlockedInt32, InterlockedInt32)

Checks if a is not equal to b.

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

Parameters

a InterlockedInt32

First operand.

b InterlockedInt32

Second operand.

Returns

bool

true when operands are not equal, otherwise false.

operator <(InterlockedInt32, InterlockedInt32)

Checks if a is less than b.

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

Parameters

a InterlockedInt32

First operand.

b InterlockedInt32

Second operand.

Returns

bool

true when a is less than b, otherwise false.

operator <=(InterlockedInt32, InterlockedInt32)

Checks if a is less than or equal to b.

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

Parameters

a InterlockedInt32

First operand.

b InterlockedInt32

Second operand.

Returns

bool

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