SolutionId

public readonly struct SolutionId : IEquatable<SolutionId>, IComparable<SolutionId>

Provides an app-wide secure way to generate solution runtime ids.

Properties

CancelledIds

public static IEnumerable<SolutionId> CancelledIds { get; }

Enumerate over the most recent cancelled solution IDs, starting with the most recent one. This iterator is thread-safe, but does not update during its lifespan. Calling IsCancelled(SolutionId) is a much faster way to check for a specific cancellation.

IsValid

public bool IsValid { get; }

Gets whether this is a valid Id.

None

public static SolutionId None { get; }

Gets an unset solution id.

Methods

CompareTo

public int CompareTo(SolutionId other)

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.

Parameters:

other (SolutionId)

An object to compare with this instance.

Returns: A value that indicates the relative order of the objects being compared.

Equals

public override bool Equals(object obj)

Indicates whether this instance and a specified object are equal.

Parameters:

obj (object)

The object to compare with the current instance.

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

Overrides: ValueType.Equals

Equals

public bool Equals(SolutionId other)

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

Parameters:

other (SolutionId)

An object to compare with this object.

GetHashCode

public override int GetHashCode()

Returns the hash code for this instance.

Returns: A hash of the solution id. Invalid hashes are always zero, valid hashes are never zero.

Overrides: ValueType.GetHashCode

GetHashCode

public int GetHashCode(out long sixtyFourBitHashCode)

Returns the hash code for this instance.

Parameters:

sixtyFourBitHashCode (out long)

Returns: A hash of the solution id. Invalid hashes are always zero, valid hashes are never zero.

IsCancelled

public static bool IsCancelled(long sixtyFourBitHash)

Gets whether a specific solution has been cancelled. There is at present no way to check whether an id is still running or whether it has completed.

Parameters:

sixtyFourBitHash (long)

The 64-bit hash code returned from GetHashCode(long).

Returns: True if the solution with the provided hash has been cancelled.

IsCancelled

public static bool IsCancelled(SolutionId id)

Gets whether a specific solution has been cancelled. There is at present no way to check whether an id is still running or whether it has completed.

Parameters:

id (SolutionId)

Id to check.

Returns: True if the solution with the provided ID has been cancelled.

ToString

public override string ToString()

Returns the fully qualified type name of this instance.

Returns: The fully qualified type name.

Overrides: ValueType.ToString

Operators

Operation			Result	Description
SolutionId	==	SolutionId	bool	Test two solutions for equality. Invalid solutions are not equal to anything, even other invalid solutions.
SolutionId	>	SolutionId	bool	Test two solutions for greater-than-ness. Invalid solutions are smaller than valid solutions, older valid solutions are smaller than newer valid solutions.
SolutionId	>=	SolutionId	bool	Test two solutions for equality or greater-than-ness. Invalid solutions are smaller than valid solutions, older valid solutions are smaller than newer valid solutions.
SolutionId	!=	SolutionId	bool	Test two solutions for inequality. Invalid solutions are not equal to anything, even other invalid solutions.
SolutionId	<	SolutionId	bool	Test two solutions for smaller-than-ness. Invalid solutions are smaller than valid solutions, older valid solutions are smaller than newer valid solutions.
SolutionId	<=	SolutionId	bool	Test two solutions for equality or smaller-than-ness. Invalid solutions are smaller than valid solutions, older valid solutions are smaller than newer valid solutions.