Utility types¶
Supporting classes in the BasicRuntime namespace for sorting, hashing, selects, timing and terminal handling.
Crc16¶
Computes crc using the supplied data.
| Kind | Method (static) |
| Returns | UInt16 |
| Use case | Call Crc16.ComputeCrc(...) directly (no instance required) when your code needs to computes crc using the supplied data. |
How this member is tested
Act: var result = Crc16.ComputeCrc(/* a populated collection */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of UInt16; verify its properties reflect the expected resulting state.
LiteDbSort1¶
Creates a new LiteDbSort1 instance using the supplied Id, Var1.
| Kind | Constructor |
| Returns | LiteDbSort1 |
| Use case | Use this constructor when your code needs a new, ready-to-use LiteDbSort1 object using the supplied Id, Var1. |
How this member is tested
Arrange: valid arguments for LiteDbSort1.
Act: var subject = new LiteDbSort1("sample", /* a valid String value */)
Assert: the constructor returns without throwing and the resulting object's state reflects the supplied arguments.
Expected: Produces a fully initialized LiteDbSort1 instance; there is no return value, but object state should reflect the constructor arguments.
Reads or writes the id value on LiteDbSort1.
| Kind | Property |
| Returns | string |
| Use case | Access id on an existing LiteDbSort1 instance when your code needs to reads or writes the id value on LiteDbSort1. |
How this member is tested
Arrange: a LiteDbSort1 instance named subject.
Act: subject.id = "sample"; var value = subject.id
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
Reads or writes the var1 value on LiteDbSort1.
| Kind | Property |
| Returns | string |
| Use case | Access var1 on an existing LiteDbSort1 instance when your code needs to reads or writes the var1 value on LiteDbSort1. |
How this member is tested
Arrange: a LiteDbSort1 instance named subject.
Act: subject.var1 = "sample"; var value = subject.var1
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
LiteDbSort2¶
Creates a new LiteDbSort2 instance using the supplied Id, Var1, Var2.
| Kind | Constructor |
| Returns | LiteDbSort2 |
| Use case | Use this constructor when your code needs a new, ready-to-use LiteDbSort2 object using the supplied Id, Var1, Var2. |
How this member is tested
Arrange: valid arguments for LiteDbSort2.
Act: var subject = new LiteDbSort2("sample", /* a valid String value */, "sample")
Assert: the constructor returns without throwing and the resulting object's state reflects the supplied arguments.
Expected: Produces a fully initialized LiteDbSort2 instance; there is no return value, but object state should reflect the constructor arguments.
Reads or writes the id value on LiteDbSort2.
| Kind | Property |
| Returns | string |
| Use case | Access id on an existing LiteDbSort2 instance when your code needs to reads or writes the id value on LiteDbSort2. |
How this member is tested
Arrange: a LiteDbSort2 instance named subject.
Act: subject.id = "sample"; var value = subject.id
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
Reads or writes the var1 value on LiteDbSort2.
| Kind | Property |
| Returns | string |
| Use case | Access var1 on an existing LiteDbSort2 instance when your code needs to reads or writes the var1 value on LiteDbSort2. |
How this member is tested
Arrange: a LiteDbSort2 instance named subject.
Act: subject.var1 = "sample"; var value = subject.var1
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
Reads or writes the var2 value on LiteDbSort2.
| Kind | Property |
| Returns | string |
| Use case | Access var2 on an existing LiteDbSort2 instance when your code needs to reads or writes the var2 value on LiteDbSort2. |
How this member is tested
Arrange: a LiteDbSort2 instance named subject.
Act: subject.var2 = "sample"; var value = subject.var2
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
LiteDbSort3¶
Creates a new LiteDbSort3 instance using the supplied Id, Var1, Var2, Var3.
| Kind | Constructor |
| Returns | LiteDbSort3 |
| Use case | Use this constructor when your code needs a new, ready-to-use LiteDbSort3 object using the supplied Id, Var1, Var2, Var3. |
How this member is tested
Arrange: valid arguments for LiteDbSort3.
Act: var subject = new LiteDbSort3("sample", /* a valid String value */, "sample", "sample")
Assert: the constructor returns without throwing and the resulting object's state reflects the supplied arguments.
Expected: Produces a fully initialized LiteDbSort3 instance; there is no return value, but object state should reflect the constructor arguments.
Reads or writes the id value on LiteDbSort3.
| Kind | Property |
| Returns | string |
| Use case | Access id on an existing LiteDbSort3 instance when your code needs to reads or writes the id value on LiteDbSort3. |
How this member is tested
Arrange: a LiteDbSort3 instance named subject.
Act: subject.id = "sample"; var value = subject.id
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
Reads or writes the var1 value on LiteDbSort3.
| Kind | Property |
| Returns | string |
| Use case | Access var1 on an existing LiteDbSort3 instance when your code needs to reads or writes the var1 value on LiteDbSort3. |
How this member is tested
Arrange: a LiteDbSort3 instance named subject.
Act: subject.var1 = "sample"; var value = subject.var1
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
Reads or writes the var2 value on LiteDbSort3.
| Kind | Property |
| Returns | string |
| Use case | Access var2 on an existing LiteDbSort3 instance when your code needs to reads or writes the var2 value on LiteDbSort3. |
How this member is tested
Arrange: a LiteDbSort3 instance named subject.
Act: subject.var2 = "sample"; var value = subject.var2
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
Reads or writes the var3 value on LiteDbSort3.
| Kind | Property |
| Returns | string |
| Use case | Access var3 on an existing LiteDbSort3 instance when your code needs to reads or writes the var3 value on LiteDbSort3. |
How this member is tested
Arrange: a LiteDbSort3 instance named subject.
Act: subject.var3 = "sample"; var value = subject.var3
Assert: value matches the expected string state.
Expected: Reading returns the current string value; writing replaces it, and a subsequent read reflects the new value.
ProcessAnsi¶
Performs the decode ansi operation using the supplied value.
| Kind | Method (static) |
| Returns | void |
| Use case | Call ProcessAnsi.decodeAnsi(...) directly (no instance required) when your code needs to perform the decode ansi operation using the supplied value. |
How this member is tested
Act: ProcessAnsi.decodeAnsi("sample")
Assert: no exception is thrown and the expected side effect occurred.
Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).
Soundex¶
Performs the generate operation using the supplied Phrase.
| Kind | Method (static) |
| Returns | string |
| Use case | Call Soundex.Generate(...) directly (no instance required) when your code needs to perform the generate operation using the supplied Phrase. |
How this member is tested
Act: var result = Soundex.Generate("sample")
Assert: result is non-null and matches the expected text.
Expected: Returns a string value; verify it is non-null and matches the expected content.
Timings¶
Performs the duration operation.
| Kind | Method |
| Returns | double |
| Use case | Call Duration(...) on an existing Timings instance when your code needs to perform the duration operation. |
How this member is tested
Arrange: a Timings instance named subject.
Act: var result = subject.Duration()
Assert: result equals the expected computed value.
Expected: Returns a double value; verify it equals the expected computed result for the given input.
internalselect¶
Creates a new internalselect instance.
| Kind | Constructor |
| Returns | internalselect |
| Use case | Use this constructor when your code needs a new, ready-to-use internalselect object. |
How this member is tested
Arrange: valid arguments for internalselect.
Act: var subject = new internalselect()
Assert: the constructor returns without throwing and the resulting object's state reflects the supplied arguments.
Expected: Produces a fully initialized internalselect instance; there is no return value, but object state should reflect the constructor arguments.
tempselect¶
Creates a new tempselect instance.
| Kind | Constructor |
| Returns | tempselect |
| Use case | Use this constructor when your code needs a new, ready-to-use tempselect object. |
How this member is tested
Arrange: valid arguments for tempselect.
Act: var subject = new tempselect()
Assert: the constructor returns without throwing and the resulting object's state reflects the supplied arguments.
Expected: Produces a fully initialized tempselect instance; there is no return value, but object state should reflect the constructor arguments.
Creates a new tempselect instance using the supplied tempPath, listName.
| Kind | Constructor |
| Returns | tempselect |
| Use case | Use this constructor when your code needs a new, ready-to-use tempselect object using the supplied tempPath, listName. |
How this member is tested
Arrange: valid arguments for tempselect.
Act: var subject = new tempselect("sample", "sample")
Assert: the constructor returns without throwing and the resulting object's state reflects the supplied arguments.
Expected: Produces a fully initialized tempselect instance; there is no return value, but object state should reflect the constructor arguments.
Performs the dequeue operation.
| Kind | Method |
| Returns | string |
| Use case | Call Dequeue(...) on an existing tempselect instance when your code needs to perform the dequeue operation. |
How this member is tested
Arrange: a tempselect instance named subject.
Act: var result = subject.Dequeue()
Assert: result is non-null and matches the expected text.
Expected: Returns a string value; verify it is non-null and matches the expected content.
Removes the value.
| Kind | Method |
| Returns | void |
| Use case | Call Remove(...) on an existing tempselect instance when your code needs to removes the value. |
How this member is tested
Arrange: a tempselect instance named subject.
Act: subject.Remove()
Assert: no exception is thrown and the expected side effect occurred.
Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).