ImmutableList<'T> Class

 

Represents an immutable list, which is a strongly typed list of objects that can be accessed by index.

NuGet package: System.Collections.Immutable (about immutable collections and how to install)

Namespace:   System.Collections.Immutable
Assembly:  System.Collections.Immutable (in System.Collections.Immutable.dll)

System.Object
  System.Collections.Immutable.ImmutableList<'T>

No code example is currently available or this language may not be supported.

Type Parameters

T

The type of elements in the list.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of elements contained in the list.

System_CAPS_pubpropertyIsEmpty

Gets a value that indicates whether this list is empty.

System_CAPS_pubpropertyItem(Int32)

Gets the element at the specified index of the list.

NameDescription
System_CAPS_pubmethodAdd('T)

Adds the specified object to the end of the immutable list.

System_CAPS_pubmethodAddRange(IEnumerable<'T>)

Adds the elements of the specified collection to the end of the immutable list.

System_CAPS_pubmethodBinarySearch('T)

Searches the entire sorted list for an element using the default comparer and returns the zero-based index of the element.

System_CAPS_pubmethodBinarySearch('T, IComparer<'T>)

Searches the entire sorted list for an element using the specified comparer and returns the zero-based index of the element.

System_CAPS_pubmethodBinarySearch(Int32, Int32, 'T, IComparer<'T>)

Searches a range of elements in the sorted list for an element using the specified comparer and returns the zero-based index of the element.

System_CAPS_pubmethodClear()

Removes all elements from the immutable list.

System_CAPS_pubmethodContains('T)

Determines whether this immutable list contains the specified value.

System_CAPS_pubmethodConvertAll<'TOutput>(Func<'T, 'TOutput>)

Converts the elements in the current immutable list to another type, and returns a list containing the converted elements.

System_CAPS_pubmethodCopyTo('T[])

Copies the entire immutable list to a compatible one-dimensional array, starting at the beginning of the target array.

System_CAPS_pubmethodCopyTo('T[], Int32)

Copies the entire immutable list to a compatible one-dimensional array, starting at the specified index of the target array.

System_CAPS_pubmethodCopyTo(Int32, 'T[], Int32, Int32)

Copies a range of elements from the immutable list to a compatible one-dimensional array, starting at the specified index of the target array.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodExists(Predicate<'T>)

Determines whether the immutable list contains elements that match the conditions defined by the specified predicate.

System_CAPS_pubmethodFind(Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire immutable list.

System_CAPS_pubmethodFindAll(Predicate<'T>)

Retrieves all the elements that match the conditions defined by the specified predicate.

System_CAPS_pubmethodFindIndex(Int32, Int32, Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the immutable list that starts at the specified index and contains the specified number of elements.

System_CAPS_pubmethodFindIndex(Int32, Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element.

System_CAPS_pubmethodFindIndex(Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire immutable list.

System_CAPS_pubmethodFindLast(Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire immutable list.

System_CAPS_pubmethodFindLastIndex(Int32, Int32, Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the immutable list that contains the specified number of elements and ends at the specified index.

System_CAPS_pubmethodFindLastIndex(Int32, Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index.

System_CAPS_pubmethodFindLastIndex(Predicate<'T>)

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire immutable list.

System_CAPS_pubmethodForEach(Action<'T>)

Performs the specified action on each element of the immutable list.

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that iterates through the immutable list.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetRange(Int32, Int32)

Creates a shallow copy of a range of elements in the source immutable list.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIndexOf('T)

Searches for the specified object and returns the zero-based index of the first occurrence within the entire immutable list.

System_CAPS_pubmethodIndexOf('T, Int32, Int32, IEqualityComparer<'T>)

Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the list that starts at the specified index and contains the specified number of elements.

System_CAPS_pubmethodInsert(Int32, 'T)

Inserts the specified object into the immutable list at the specified index.

System_CAPS_pubmethodInsertRange(Int32, IEnumerable<'T>)

Inserts the elements of a collection into the immutable list at the specified index.

System_CAPS_pubmethodLastIndexOf('T, Int32, Int32, IEqualityComparer<'T>)

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the list that contains the specified number of elements and ends at the specified index.

System_CAPS_pubmethodRemove('T)

Removes the first occurrence of the specified object from this immutable list.

System_CAPS_pubmethodRemove('T, IEqualityComparer<'T>)

Removes the first occurrence of the object that matches the specified value from this immutable list.

System_CAPS_pubmethodRemoveAll(Predicate<'T>)

Removes all the elements that match the conditions defined by the specified predicate.

System_CAPS_pubmethodRemoveAt(Int32)

Removes the element at the specified index.

System_CAPS_pubmethodRemoveRange(IEnumerable<'T>)

Removes a range of elements from this immutable list.

System_CAPS_pubmethodRemoveRange(IEnumerable<'T>, IEqualityComparer<'T>)

Removes the specified values from this list.

System_CAPS_pubmethodRemoveRange(Int32, Int32)

Removes a range of elements, starting from the specified index and containing the specified number of elements, from this immutable list.

System_CAPS_pubmethodReplace('T, 'T)

Replaces the specified element in the immutable list with a new element.

System_CAPS_pubmethodReplace('T, 'T, IEqualityComparer<'T>)

Replaces the specified element in the immutable list with a new element.

System_CAPS_pubmethodReverse()

Reverses the order of the elements in the entire immutable list.

System_CAPS_pubmethodReverse(Int32, Int32)

Reverses the order of the elements in the specified range of the immutable list.

System_CAPS_pubmethodSetItem(Int32, 'T)

Replaces an element at a given position in the immutable list with the specified element.

System_CAPS_pubmethodSort()

Sorts the elements in the entire immutable list using the default comparer.

System_CAPS_pubmethodSort(Comparison<'T>)

Sorts the elements in the entire immutable list using the specified comparer.

System_CAPS_pubmethodSort(IComparer<'T>)

Sorts the elements in the entire immutable list using the specified comparer.

System_CAPS_pubmethodSort(Int32, Int32, IComparer<'T>)

Sorts a range of elements in the immutable list using the specified comparer.

System_CAPS_pubmethodToBuilder()

Creates a list that has the same contents as this list and can be efficiently mutated across multiple operations using standard mutable interfaces.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodTrueForAll(Predicate<'T>)

Determines whether every element in the immutable list matches the conditions defined by the specified predicate.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticEmpty

Gets an empty set with the default sort comparer.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection<'T>.Add('T)

Adds the specified item to the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection<'T>.Clear()

Removes all items from the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection<'T>.Remove('T)

Removes the first occurrence of a specific object from the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable<'T>.GetEnumerator()

Returns an enumerator that iterates through the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList<'T>.Insert(Int32, 'T)

Inserts an object in the immutable list at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList<'T>.RemoveAt(Int32)

Removes the value at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the entire immutable list to a compatible one-dimensional array, starting at the specified array index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Returns an enumerator that iterates through the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)

Adds an item to the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Clear()

Removes all items from the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

Determines whether the immutable list contains a specific value.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

Determines the index of a specific item in the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

Inserts an item into the immutable list at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

Removes the first occurrence of a specific object from the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.RemoveAt(Int32)

Removes the item at the specified index of the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.Add('T)

Adds the specified value to this immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.AddRange(IEnumerable<'T>)

Adds the specified values to this immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.Clear()

Retrieves an empty list that has the same sorting and ordering semantics as this instance.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.Insert(Int32, 'T)

Inserts the specified element at the specified index in the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.InsertRange(Int32, IEnumerable<'T>)

Inserts the specified elements at the specified index in the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.Remove('T, IEqualityComparer<'T>)

Removes the element with the specified value from the list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.RemoveAll(Predicate<'T>)

Removes all the elements that match the conditions defined by the specified predicate.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.RemoveAt(Int32)

Removes the element at the specified index of the immutable list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.RemoveRange(IEnumerable<'T>, IEqualityComparer<'T>)

Removes a range of elements from this immutable list that match the items specified.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.RemoveRange(Int32, Int32)

Removes the specified number of elements at the specified location from this list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.Replace('T, 'T, IEqualityComparer<'T>)

Replaces an element in the list with the specified element.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIImmutableList<'T>.SetItem(Int32, 'T)

Replaces an element in the list at a given position with the specified element.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection<'T>.IsReadOnly

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

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList<'T>.Item(Int32)

Gets or sets the value at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

See the ICollection interface.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot
System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

Gets a value indicating whether the IList has a fixed size.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsReadOnly

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

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item(Int32)

Gets or sets the Object at the specified index.

NameDescription
System_CAPS_pubmethodIndexOf<'T>('T)

Overloaded. Searches for the specified object and returns the zero-based index of the first occurrence within the list.(Defined by ImmutableList.)

System_CAPS_pubmethodIndexOf<'T>('T, IEqualityComparer<'T>)

Overloaded. Searches for the specified object and returns the zero-based index of the first occurrence within the list.(Defined by ImmutableList.)

System_CAPS_pubmethodIndexOf<'T>('T, Int32)

Overloaded. Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element.(Defined by ImmutableList.)

System_CAPS_pubmethodIndexOf<'T>('T, Int32, Int32)

Overloaded. Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element.(Defined by ImmutableList.)

System_CAPS_pubmethodLastIndexOf<'T>('T)

Overloaded. Searches for the specified object and returns the zero-based index of the last occurrence within the entire immutable list.(Defined by ImmutableList.)

System_CAPS_pubmethodLastIndexOf<'T>('T, IEqualityComparer<'T>)

Overloaded. Searches for the specified object and returns the zero-based index of the last occurrence within the entire immutable list.(Defined by ImmutableList.)

System_CAPS_pubmethodLastIndexOf<'T>('T, Int32)

Overloaded. Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index.(Defined by ImmutableList.)

System_CAPS_pubmethodLastIndexOf<'T>('T, Int32, Int32)

Overloaded. Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index.(Defined by ImmutableList.)

System_CAPS_pubmethodRemove<'T>('T)

Removes the specified value from this list.(Defined by ImmutableList.)

System_CAPS_pubmethodRemoveRange<'T>(IEnumerable<'T>)

Removes the specified values from this list.(Defined by ImmutableList.)

System_CAPS_pubmethodReplace<'T>('T, 'T)

Replaces the first equal element in the list with the specified element.(Defined by ImmutableList.)

System_CAPS_pubmethodToImmutableArray<'T>()

Creates an immutable array from the specified collection.(Defined by ImmutableArray.)

System_CAPS_pubmethodToImmutableDictionary<'T, 'TKey>(Func<'T, 'TKey>)

Overloaded. Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys.(Defined by ImmutableDictionary.)

System_CAPS_pubmethodToImmutableDictionary<'T, 'TKey>(Func<'T, 'TKey>, IEqualityComparer<'TKey>)

Overloaded. Constructs an immutable dictionary based on some transformation of a sequence.(Defined by ImmutableDictionary.)

System_CAPS_pubmethodToImmutableDictionary<'T, 'TKey, 'TValue>(Func<'T, 'TKey>, Func<'T, 'TValue>)

Overloaded. Enumerates and transforms a sequence, and produces an immutable dictionary of its contents.(Defined by ImmutableDictionary.)

System_CAPS_pubmethodToImmutableDictionary<'T, 'TKey, 'TValue>(Func<'T, 'TKey>, Func<'T, 'TValue>, IEqualityComparer<'TKey>)

Overloaded. Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer.(Defined by ImmutableDictionary.)

System_CAPS_pubmethodToImmutableDictionary<'T, 'TKey, 'TValue>(Func<'T, 'TKey>, Func<'T, 'TValue>, IEqualityComparer<'TKey>, IEqualityComparer<'TValue>)

Overloaded. Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers.(Defined by ImmutableDictionary.)

System_CAPS_pubmethodToImmutableHashSet<'T>()

Overloaded. Enumerates a sequence and produces an immutable hash set of its contents.(Defined by ImmutableHashSet.)

System_CAPS_pubmethodToImmutableHashSet<'T>(IEqualityComparer<'T>)

Overloaded. Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type.(Defined by ImmutableHashSet.)

System_CAPS_pubmethodToImmutableList<'T>()

Enumerates a sequence and produces an immutable list of its contents.(Defined by ImmutableList.)

System_CAPS_pubmethodToImmutableSortedDictionary<'T, 'TKey, 'TValue>(Func<'T, 'TKey>, Func<'T, 'TValue>)

Overloaded. Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents.(Defined by ImmutableSortedDictionary.)

System_CAPS_pubmethodToImmutableSortedDictionary<'T, 'TKey, 'TValue>(Func<'T, 'TKey>, Func<'T, 'TValue>, IComparer<'TKey>)

Overloaded. Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer.(Defined by ImmutableSortedDictionary.)

System_CAPS_pubmethodToImmutableSortedDictionary<'T, 'TKey, 'TValue>(Func<'T, 'TKey>, Func<'T, 'TValue>, IComparer<'TKey>, IEqualityComparer<'TValue>)

Overloaded. Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers.(Defined by ImmutableSortedDictionary.)

System_CAPS_pubmethodToImmutableSortedSet<'T>()

Overloaded. Enumerates a sequence and produces an immutable sorted set of its contents.(Defined by ImmutableSortedSet.)

System_CAPS_pubmethodToImmutableSortedSet<'T>(IComparer<'T>)

Overloaded. Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer.(Defined by ImmutableSortedSet.)

When you add or remove items from an immutable list, a copy of the original list is made with the items added or removed, and the original list is unchanged.

This type is thread safe.

Return to top
Show: