Struct LinearDictionary<TKey, TValue>.KeyCollection

Namespace

Uncreated.Warfare.Util.List

Assembly

Uncreated.Warfare.dll

Key collection for LinearDictionary<TKey, TValue>.

public readonly struct LinearDictionary<TKey, TValue>.KeyCollection : ICollection<TKey>, IReadOnlyCollection<TKey>, IEnumerable<TKey>, ICollection, IEnumerable

Implements

ICollection<TKey>

IReadOnlyCollection<TKey>

IEnumerable<TKey>

ICollection

IEnumerable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

CollectionUtility.IsNullOrEmpty<T>(ICollection<T>?)

CollectionUtility.ToArrayFast<TElement>(IEnumerable<TElement>, bool)

TrackingListExtensions.ToReadOnlyTrackingList<T>(IEnumerable<T>)

TrackingListExtensions.ToTrackingList<T>(IEnumerable<T>)

Constructors

KeyCollection(LinearDictionary<TKey, TValue>)

public KeyCollection(LinearDictionary<TKey, TValue> dictionary)

Parameters

dictionary LinearDictionary<TKey, TValue>

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(TKey)

public void Add(TKey item)

Parameters

item TKey

Exceptions

NotSupportedException

Clear()

Remove all items from the corresponding dictionary.

public void Clear()

Contains(TKey)

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

public bool Contains(TKey item)

Parameters

item TKey

The object to locate in the ICollection<T>.

Returns

bool

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

CopyTo(Array, int)

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

public void CopyTo(Array array, int index)

Parameters

array Array

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

index int

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

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

index is less than zero.

ArgumentException

    <code class="paramref">array</code> is multidimensional.  

-or-
The number of elements in the source ICollection is greater than the available space from index to the end of the destination array.
-or-
The type of the source ICollection cannot be cast automatically to the type of the destination array.

CopyTo(TKey[], int)

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

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

Parameters

array TKey[]

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 LinearDictionary<TKey, TValue>.KeyEnumerator GetEnumerator()

Returns

LinearDictionary<TKey, TValue>.KeyEnumerator

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

Remove(TKey)

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

public bool Remove(TKey item)

Parameters

item TKey

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.