Struct RentedMemorySequence<T>
A lightweight container for an underlying MemorySequencePool<T> node.
public struct RentedMemorySequence<T> : IReadOnlyList<T>, IReadOnlyCollection<T>, ICollection<T>, IEnumerable<T>, IEnumerable, IDisposableType Parameters
TElement type.
- Implements
-
ICollection<T>IEnumerable<T>
- Inherited Members
- Extension Methods
Fields
Empty
An empty sequence. This instance cannot be used to create larger sequences.
public static readonly RentedMemorySequence<T> EmptyField Value
Properties
this[int]
Gets or sets the element at the specified position in this sequence.
public T this[int index] { get; set; }Parameters
indexintThe zero-based index of the element to get or set.
Property Value
- T
Exceptions
- ArgumentOutOfRangeException
When
indexis less than 0 or greater than or equal to Length.
Length
Number of elements in this sequence.
public readonly int Length { get; }Property Value
Owner
MemorySequencePool<T> instance that owns this sequence.
public MemorySequencePool<T>? Owner { get; }Property Value
Segments
Creates a new RentedMemorySequenceSegmentCollection<T> instance from this sequence.
public RentedMemorySequenceSegmentCollection<T> Segments { get; }Property Value
Methods
Clear()
Sets all elements to the default value in this sequence.
public void Clear()Contains(T)
Checks whether or not the provided item exists in this sequence.
[Pure]
public bool Contains(T item)Parameters
itemTItem to check.
Returns
- bool
true when the provided
itemexists, otherwise false.
CopyFrom(ReadOnlySpan<T>)
Copies the provided span to this sequence.
public void CopyFrom(ReadOnlySpan<T> span)Parameters
spanReadOnlySpan<T>Copy source.
Remarks
Does nothing when this sequence has been returned to the pool.
Exceptions
- ArgumentOutOfRangeException
When Length is less than length of the provided
span.
CopyTo(RentedMemorySequenceSpan<T>)
Copies this sequence to the provided span.
public void CopyTo(RentedMemorySequenceSpan<T> span)Parameters
spanRentedMemorySequenceSpan<T>Copy destination.
Exceptions
- ArgumentOutOfRangeException
When Length is greater than length of the provided
span.
CopyTo(Span<T>)
Copies this sequence to the provided span.
public void CopyTo(Span<T> span)Parameters
spanSpan<T>Copy destination.
Exceptions
- ArgumentOutOfRangeException
When Length is greater than length of the provided
span.
CopyTo(T[], int)
Copies this sequence to the provided array, starting from the given arrayIndex.
public void CopyTo(T[] array, int arrayIndex)Parameters
arrayT[]Copy destination.
arrayIndexintIndex of the destination
arrayat which to start copying to.
Exceptions
- ArgumentOutOfRangeException
When
arrayIndexis less than 0 or greater than or equal to the length of the providedarrayor Length is greater than length of the providedarraysegment.
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()Remarks
Frees the underlying node and returns it to the pool.
Expand(int)
Increases Length of this sequence by the provided length.
public void Expand(int length)Parameters
Remarks
Does nothing when this sequence has been returned to the pool or length is less than 1.
GetEnumerator()
Creates a new RentedMemorySequence<T>.Enumerator instance for this sequence.
[Pure]
public RentedMemorySequence<T>.Enumerator GetEnumerator()Returns
- RentedMemorySequence<T>.Enumerator
New RentedMemorySequence<T>.Enumerator instance.
GetRef(int)
Returns a reference to an element at the specified position.
[Pure]
public ref T GetRef(int index)Parameters
indexintThe zero-based index of the element reference to get.
Returns
- T
Reference to an element at the specified position.
Exceptions
- ArgumentOutOfRangeException
When
indexis less than 0 or greater than or equal to Length.
Push(T)
Increases Length of this sequence by 1 and sets the last element.
public void Push(T item)Parameters
itemTElement to add.
Remarks
Does nothing when this sequence has been returned to the pool.
Refresh()
Refreshes this sequence's Length.
public void Refresh()Remarks
Some operations may cause the underlying node to be modified. This method can be used to synchronize a sequence with it's node's state.
Set(int, T)
Sets an element at the specified position.
public void Set(int index, T item)Parameters
indexintThe zero-based index of the element to set.
itemTElement to set.
Exceptions
- ArgumentOutOfRangeException
When
indexis less than 0 or greater than or equal to Length.
Slice(int)
Creates a new RentedMemorySequenceSpan<T> instance.
[Pure]
public RentedMemorySequenceSpan<T> Slice(int startIndex)Parameters
startIndexintIndex of the first element that should be included in the slice.
Returns
- RentedMemorySequenceSpan<T>
New RentedMemorySequenceSpan<T> instance.
Exceptions
- ArgumentOutOfRangeException
When
startIndexis less than 0 or is greater than or equal to Length.
Slice(int, int)
Creates a new RentedMemorySequenceSpan<T> instance.
[Pure]
public RentedMemorySequenceSpan<T> Slice(int startIndex, int length)Parameters
startIndexintIndex of the first element that should be included in the slice.
lengthintLength of the slice.
Returns
- RentedMemorySequenceSpan<T>
New RentedMemorySequenceSpan<T> instance.
Exceptions
- ArgumentOutOfRangeException
When
startIndexis less than 0 orlengthis less than 0 or computed index of the last element in the slice is greater than or equal to Length.
Sort(Comparer<T>?)
Sorts elements in this sequence.
public void Sort(Comparer<T>? comparer = null)Parameters
comparerComparer<T>Optional comparer to use for sorting elements.
Sort(Comparison<T>)
Sorts elements in this sequence.
public void Sort(Comparison<T> comparer)Parameters
comparerComparison<T>Delegate used for sorting elements.
ToArray()
Creates a new Array instance from this sequence.
[Pure]
public T[] ToArray()Returns
- T[]
New Array instance.
ToString()
Returns a string representation of this RentedMemorySequence<T> instance.
[Pure]
public override string ToString()Returns
- string
String representation.
Operators
implicit operator RentedMemorySequenceSpan<T>(RentedMemorySequence<T>)
Converts a sequence to an equivalent RentedMemorySequenceSpan<T> instance.
[Pure]
public static implicit operator RentedMemorySequenceSpan<T>(RentedMemorySequence<T> s)Parameters
sRentedMemorySequence<T>Source sequence.
Returns
- RentedMemorySequenceSpan<T>
New RentedMemorySequenceSpan<T> instance.