Index Struct
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a type that can be used to index a collection either from the beginning or the end.
public value class Index : IEquatable<Index>
public readonly struct Index : IEquatable<Index>
type Index = struct
Public Structure Index
Implements IEquatable(Of Index)
- Inheritance
- Implements
Index
is used by the C# compiler to support the ^
or "index from end" operator:
int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
int lastElement = someArray[^1]; // lastElement = 5
Index(Int32, Boolean) |
Initializes a new Index with a specified index position and a value that indicates if the index is from the beginning or the end of a collection. |
End |
Gets an Index that points beyond the last element. |
Is |
Gets a value that indicates whether the index is from the start or the end. |
Start |
Gets an Index that points to the first element of a collection. |
Value |
Gets the index value. |
Equals(Index) |
Returns a value that indicates whether the current object is equal to another Index object. |
Equals(Object) |
Indicates whether the current Index object is equal to a specified object. |
From |
Creates an Index from the end of a collection at a specified index position. |
From |
Creates an Index from the specified index at the start of a collection. |
Get |
Returns the hash code for this instance. |
Get |
Calculates the offset from the start of the collection using the specified collection length. |
To |
Returns the string representation of the current Index instance. |
Implicit(Int32 to Index) |
Converts an integer number to an Index. |
Product | Versions |
---|---|
.NET | Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Standard | 2.0 (package-provided), 2.1 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: