Struct ValueSlice<T>
- Namespace
- Badeend.ValueCollections
- Assembly
- Badeend.ValueCollections.dll
An immutable, thread-safe span with value semantics.
public readonly struct ValueSlice<T> : IEquatable<ValueSlice<T>>Type Parameters
TThe type of items in the slice.
- Implements
-
IEquatable<ValueSlice<T>>
- Inherited Members
Remarks
This type is similar to ReadOnlySpan<T> and ReadOnlyMemory<T> in that this too is just a view into an existing allocation at a specified offset+length. Taking a subslice with Slice(int) and Slice(int, int) is very cheap as it reuses the same allocation and only adjusts the internal offset+length fields.
Unlike ReadOnlySpan&Memory, the data is not just read-only but it is also guaranteed to be immutable.
Additionally, ValueSlice has "structural equality". This means that two slices are considered equal only when their contents are equal. As long as a value is present in a ValueSlice, its hash code may not change.
To prevent accidental boxing, ValueSlice does not implement commonly used interfaces such as IEnumerable<T> and IReadOnlyList<T>. You can still use these interfaces by manually calling AsEnumerable() or AsReadOnlyList() instead.
The default value of every ValueSlice is an empty slice.
Properties
Empty
Get an empty slice.
This does not allocate any memory.
[Pure]
public static ValueSlice<T> Empty { get; }Property Value
- ValueSlice<T>
IsEmpty
Shortcut for .Length == 0.
[Pure]
public bool IsEmpty { get; }Property Value
this[int]
Get an item from the slice at the specified index.
public ref readonly T this[int index] { get; }Parameters
indexint
Property Value
- T
Length
Length of the slice.
[Pure]
public int Length { get; }Property Value
Memory
Access the slice's contents using a ReadOnlyMemory<T>.
[Pure]
public ReadOnlyMemory<T> Memory { get; }Property Value
Span
Access the slice's contents using a ReadOnlySpan<T>.
[Pure]
public ReadOnlySpan<T> Span { get; }Property Value
- ReadOnlySpan<T>
Methods
AsEnumerable()
Create a new IEnumerable<T> view over the slice.
This method allocates a new fixed-size IEnumerable instance. The items are not copied.
[Pure]
public IEnumerable<T> AsEnumerable()Returns
- IEnumerable<T>
AsReadOnlyList()
Create a new IReadOnlyList<T> view over the slice.
This method allocates a new fixed-size IReadOnlyList instance. The items are not copied.
[Pure]
public IReadOnlyList<T> AsReadOnlyList()Returns
BinarySearch(T)
Perform a binary search for item within the slice.
The slice is assumed to already be sorted. This uses the
Default comparer and throws if
T is not comparable. If the item is found, its
index is returned. Otherwise a negative value is returned representing
the bitwise complement of the index where the item should be inserted.
[Pure]
public int BinarySearch(T item)Parameters
itemT
Returns
Contains(T)
Returns true when this slice
contains the specified item.
[Pure]
public bool Contains(T item)Parameters
itemT
Returns
CopyTo(Span<T>)
Copy the contents of the slice into an existing Span<T>.
Similar to CopyTo(Span<T>).
public void CopyTo(Span<T> destination)Parameters
destinationSpan<T>
Exceptions
- ArgumentException
destinationis shorter than the source slice.
Equals(ValueSlice<T>)
Returns true when the two slices have identical length and content.
[Pure]
public bool Equals(ValueSlice<T> other)Parameters
otherValueSlice<T>
Returns
GetEnumerator()
Returns an enumerator for this ValueSlice<T>.
Typically, you don't need to manually call this method, but instead use
the built-in foreach syntax.
[Pure]
public ValueSlice<T>.Enumerator GetEnumerator()Returns
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.
IndexOf(T)
Return the index of the first occurrence of item in
this, or -1 if not found.
[Pure]
public int IndexOf(T item)Parameters
itemT
Returns
LastIndexOf(T)
Return the index of the last occurrence of item in
this, or -1 if not found.
[Pure]
public int LastIndexOf(T item)Parameters
itemT
Returns
Slice(int)
[Pure]
public ValueSlice<T> Slice(int offset)Parameters
offsetintThe index at which to begin the subslice.
Returns
- ValueSlice<T>
Exceptions
- ArgumentOutOfRangeException
offsetis below0or greater than the current slice's length.
Slice(int, int)
Create a subslice with a specified length,
starting at offset.
This does not allocate any memory.
Similar to Slice(int, int).
[Pure]
public ValueSlice<T> Slice(int offset, int length)Parameters
Returns
- ValueSlice<T>
Exceptions
- ArgumentOutOfRangeException
offsetis below0or greater than the current slice's length.- ArgumentOutOfRangeException
lengthis below0or would extend beyond the current slice's length.
ToArray()
Copy the contents of the slice into a new array.
Similar to ToArray().
[Pure]
public T[] ToArray()Returns
- T[]
ToString()
Get a string representation of the collection for debugging purposes. The format is not stable and may change without prior notice.
[Pure]
public override string ToString()Returns
ToValueList()
Copy the slice into a new ValueList<T>.
[Pure]
public ValueList<T> ToValueList()Returns
- ValueList<T>
TryCopyTo(Span<T>)
Attempt to copy the contents of the slice into an existing
Span<T>. If the destination is too short,
no items are copied and the method returns false.
Similar to TryCopyTo(Span<T>).
public bool TryCopyTo(Span<T> destination)Parameters
destinationSpan<T>
Returns
Operators
operator ==(ValueSlice<T>, ValueSlice<T>)
Check for equality.
[Pure]
public static bool operator ==(ValueSlice<T> left, ValueSlice<T> right)Parameters
leftValueSlice<T>rightValueSlice<T>
Returns
operator !=(ValueSlice<T>, ValueSlice<T>)
Check for inequality.
[Pure]
public static bool operator !=(ValueSlice<T> left, ValueSlice<T> right)Parameters
leftValueSlice<T>rightValueSlice<T>