Class InlineArrayEnumerable<TArray, TElement>

Namespace

PolyType.SourceGenModel

Assembly

PolyType.dll

Helper class for iterating over inline arrays.

public sealed class InlineArrayEnumerable<TArray, TElement> : ICollection<TElement>, IReadOnlyCollection<TElement>, IEnumerable<TElement>, IEnumerable where TArray : struct

Type Parameters

TArray

The type of the inline array.

TElement

The type of the element.

Inheritance

object

InlineArrayEnumerable<TArray, TElement>

Implements

ICollection<TElement>

IReadOnlyCollection<TElement>

IEnumerable<TElement>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

InlineArrayEnumerable(TArray, int)

Helper class for iterating over inline arrays.

public InlineArrayEnumerable(TArray array, int length)

Parameters

array TArray

length int

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

Methods

Add(TElement)

Adds an item to the ICollection<T>.

public void Add(TElement item)

Parameters

item TElement

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(TElement)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(TElement item)

Parameters

item TElement

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(TElement[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(TElement[] array, int arrayIndex)

Parameters

array TElement[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<TElement> GetEnumerator()

Returns

IEnumerator<TElement>

An enumerator that can be used to iterate through the collection.

Remove(TElement)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(TElement item)

Parameters

item TElement

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.