UNPKG

com.wallstop-studios.unity-helpers

Version:
601 lines (587 loc) 466 kB
<?xml version="1.0" encoding="utf-8"?> <doc> <assembly> <name>System.Collections.Immutable</name> </assembly> <members> <member name="T:System.Collections.Immutable.IImmutableDictionary`2"> <summary>Represents an immutable collection of key/value pairs. NuGet package: System.Collections.Immutable (about immutable collections and how to install)</summary> <typeparam name="TKey">The type of keys in the dictionary.</typeparam> <typeparam name="TValue">The type of values in the dictionary.</typeparam> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.Add(`0,`1)"> <summary>Adds an element with the specified key and value to the dictionary.</summary> <param name="key">The key of the element to add.</param> <param name="value">The value of the element to add.</param> <exception cref="T:System.ArgumentException">The given key already exists in the dictionary but has a different value.</exception> <returns>A new immutable dictionary that contains the additional key/value pair.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.AddRange(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{`0,`1}})"> <summary>Adds the specified key/value pairs to the dictionary.</summary> <param name="pairs">The key/value pairs to add.</param> <exception cref="T:System.ArgumentException">One of the given keys already exists in the dictionary but has a different value.</exception> <returns>A new immutable dictionary that contains the additional key/value pairs.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.Clear"> <summary>Retrieves an empty dictionary that has the same ordering and key/value comparison rules as this dictionary instance.</summary> <returns>An empty dictionary with equivalent ordering and key/value comparison rules.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.Contains(System.Collections.Generic.KeyValuePair{`0,`1})"> <summary>Determines whether the immutable dictionary contains the specified key/value pair.</summary> <param name="pair">The key/value pair to locate.</param> <returns> <see langword="true" /> if the specified key/value pair is found in the dictionary; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.Remove(`0)"> <summary>Removes the element with the specified key from the immutable dictionary.</summary> <param name="key">The key of the element to remove.</param> <returns>A new immutable dictionary with the specified element removed; or this instance if the specified key cannot be found in the dictionary.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.RemoveRange(System.Collections.Generic.IEnumerable{`0})"> <summary>Removes the elements with the specified keys from the immutable dictionary.</summary> <param name="keys">The keys of the elements to remove.</param> <returns>A new immutable dictionary with the specified keys removed; or this instance if the specified keys cannot be found in the dictionary.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.SetItem(`0,`1)"> <summary>Sets the specified key and value in the immutable dictionary, possibly overwriting an existing value for the key.</summary> <param name="key">The key of the entry to add.</param> <param name="value">The key value to set.</param> <returns>A new immutable dictionary that contains the specified key/value pair.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.SetItems(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{`0,`1}})"> <summary>Sets the specified key/value pairs in the immutable dictionary, possibly overwriting existing values for the keys.</summary> <param name="items">The key/value pairs to set in the dictionary. If any of the keys already exist in the dictionary, this method will overwrite their previous values.</param> <returns>A new immutable dictionary that contains the specified key/value pairs.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableDictionary`2.TryGetKey(`0,`0@)"> <summary>Determines whether this dictionary contains a specified key.</summary> <param name="equalKey">The key to search for.</param> <param name="actualKey">The matching key located in the dictionary if found, or <c>equalkey</c> if no match is found.</param> <returns> <see langword="true" /> if a match for <paramref name="equalKey" /> is found; otherwise, <see langword="false" />.</returns> </member> <member name="T:System.Collections.Immutable.IImmutableList`1"> <summary>Represents a list of elements that cannot be modified. NuGet package: System.Collections.Immutable (about immutable collections and how to install)</summary> <typeparam name="T">The type of elements in the list.</typeparam> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.Add(`0)"> <summary>Makes a copy of the list, and adds the specified object to the end of the copied list.</summary> <param name="value">The object to add to the list.</param> <returns>A new list with the object added.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> <summary>Makes a copy of the list and adds the specified objects to the end of the copied list.</summary> <param name="items">The objects to add to the list.</param> <returns>A new list with the elements added.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.Clear"> <summary>Creates a list with all the items removed, but with the same sorting and ordering semantics as this list.</summary> <returns>An empty list that has the same sorting and ordering semantics as this instance.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.IndexOf(`0,System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})"> <summary>Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the <see cref="T:System.Collections.Immutable.IImmutableList`1" /> that starts at the specified index and contains the specified number of elements.</summary> <param name="item">The object to locate in the <see cref="T:System.Collections.Immutable.IImmutableList`1" />. This value can be null for reference types.</param> <param name="index">The zero-based starting indexes of the search. 0 (zero) is valid in an empty list.</param> <param name="count">The number of elements in the section to search.</param> <param name="equalityComparer">The equality comparer to use to locate <paramref name="item" />.</param> <returns>The zero-based index of the first occurrence of <paramref name="item" /> within the range of elements in the <see cref="T:System.Collections.Immutable.IImmutableList`1" /> that starts at <paramref name="index" /> and contains <paramref name="count" /> number of elements if found; otherwise -1.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.Insert(System.Int32,`0)"> <summary>Inserts the specified element at the specified index in the immutable list.</summary> <param name="index">The zero-based index at which to insert the value.</param> <param name="element">The object to insert.</param> <returns>A new immutable list that includes the specified element.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> <summary>Inserts the specified elements at the specified index in the immutable list.</summary> <param name="index">The zero-based index at which the new elements should be inserted.</param> <param name="items">The elements to insert.</param> <returns>A new immutable list that includes the specified elements.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.LastIndexOf(`0,System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})"> <summary>Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the <see cref="T:System.Collections.Immutable.IImmutableList`1" /> that contains the specified number of elements and ends at the specified index.</summary> <param name="item">The object to locate in the list. The value can be <see langword="null" /> for reference types.</param> <param name="index">The zero-based starting index of the search. 0 (zero) is valid in an empty list.</param> <param name="count">The number of elements in the section to search.</param> <param name="equalityComparer">The equality comparer to match <paramref name="item" />.</param> <returns>Returns <see cref="T:System.Int32" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.Remove(`0,System.Collections.Generic.IEqualityComparer{`0})"> <summary>Removes the first occurrence of a specified object from this immutable list.</summary> <param name="value">The object to remove from the list.</param> <param name="equalityComparer">The equality comparer to use to locate <paramref name="value" />.</param> <returns>A new list with the specified object removed.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.RemoveAll(System.Predicate{`0})"> <summary>Removes all the elements that match the conditions defined by the specified predicate.</summary> <param name="match">The delegate that defines the conditions of the elements to remove.</param> <returns>A new immutable list with the elements removed.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.RemoveAt(System.Int32)"> <summary>Removes the element at the specified index of the immutable list.</summary> <param name="index">The index of the element to remove.</param> <returns>A new list with the element removed.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.RemoveRange(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEqualityComparer{`0})"> <summary>Removes the specified object from the list.</summary> <param name="items">The objects to remove from the list.</param> <param name="equalityComparer">The equality comparer to use to determine if <paramref name="items" /> match any objects in the list.</param> <returns>A new immutable list with the specified objects removed, if <paramref name="items" /> matched objects in the list.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.RemoveRange(System.Int32,System.Int32)"> <summary>Removes a range of elements from the <see cref="T:System.Collections.Immutable.IImmutableList`1" />.</summary> <param name="index">The zero-based starting index of the range of elements to remove.</param> <param name="count">The number of elements to remove.</param> <returns>A new immutable list with the elements removed.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.Replace(`0,`0,System.Collections.Generic.IEqualityComparer{`0})"> <summary>Returns a new list with the first matching element in the list replaced with the specified element.</summary> <param name="oldValue">The element to be replaced.</param> <param name="newValue">The element to replace the first occurrence of <paramref name="oldValue" /> with</param> <param name="equalityComparer">The equality comparer to use for matching <paramref name="oldValue" />.</param> <exception cref="T:System.ArgumentException"> <paramref name="oldValue" /> does not exist in the list.</exception> <returns>A new list that contains <paramref name="newValue" />, even if <paramref name="oldvalue" /> is the same as <paramref name="newValue" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableList`1.SetItem(System.Int32,`0)"> <summary>Replaces an element in the list at a given position with the specified element.</summary> <param name="index">The position in the list of the element to replace.</param> <param name="value">The element to replace the old element with.</param> <returns>A new list that contains the new element, even if the element at the specified location is the same as the new element.</returns> </member> <member name="T:System.Collections.Immutable.IImmutableQueue`1"> <summary>Represents an immutable first-in, first-out collection of objects. NuGet package: System.Collections.Immutable (about immutable collections and how to install)</summary> <typeparam name="T">The type of elements in the queue.</typeparam> </member> <member name="M:System.Collections.Immutable.IImmutableQueue`1.Clear"> <summary>Returns a new queue with all the elements removed.</summary> <returns>An empty immutable queue.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableQueue`1.Dequeue"> <summary>Removes the first element in the immutable queue, and returns the new queue.</summary> <exception cref="T:System.InvalidOperationException">The queue is empty.</exception> <returns>The new immutable queue with the first element removed. This value is never <see langword="null" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableQueue`1.Enqueue(`0)"> <summary>Adds an element to the end of the immutable queue, and returns the new queue.</summary> <param name="value">The element to add.</param> <returns>The new immutable queue with the specified element added.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableQueue`1.Peek"> <summary>Returns the element at the beginning of the immutable queue without removing it.</summary> <exception cref="T:System.InvalidOperationException">The queue is empty.</exception> <returns>The element at the beginning of the queue.</returns> </member> <member name="P:System.Collections.Immutable.IImmutableQueue`1.IsEmpty"> <summary>Gets a value that indicates whether this immutable queue is empty.</summary> <returns> <see langword="true" /> if this queue is empty; otherwise, <see langword="false" />.</returns> </member> <member name="T:System.Collections.Immutable.IImmutableSet`1"> <summary>Represents a set of elements that can only be modified by creating a new instance of the set. NuGet package: System.Collections.Immutable (about immutable collections and how to install)</summary> <typeparam name="T">The type of element stored in the set.</typeparam> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Add(`0)"> <summary>Adds the specified element to this immutable set.</summary> <param name="value">The element to add.</param> <returns>A new set with the element added, or this set if the element is already in the set.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Clear"> <summary>Retrieves an empty immutable set that has the same sorting and ordering semantics as this instance.</summary> <returns>An empty set that has the same sorting and ordering semantics as this instance.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Contains(`0)"> <summary>Determines whether this immutable set contains a specified element.</summary> <param name="value">The element to locate in the set.</param> <returns> <see langword="true" /> if the set contains the specified value; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Except(System.Collections.Generic.IEnumerable{`0})"> <summary>Removes the elements in the specified collection from the current immutable set.</summary> <param name="other">The collection of items to remove from this set.</param> <returns>A new set with the items removed; or the original set if none of the items were in the set.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Intersect(System.Collections.Generic.IEnumerable{`0})"> <summary>Creates an immutable set that contains only elements that exist in this set and the specified set.</summary> <param name="other">The collection to compare to the current <see cref="T:System.Collections.Immutable.IImmutableSet`1" />.</param> <returns>A new immutable set that contains elements that exist in both sets.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.IsProperSubsetOf(System.Collections.Generic.IEnumerable{`0})"> <summary>Determines whether the current immutable set is a proper (strict) subset of the specified collection.</summary> <param name="other">The collection to compare to the current set.</param> <returns> <see langword="true" /> if the current set is a proper subset of the specified collection; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.IsProperSupersetOf(System.Collections.Generic.IEnumerable{`0})"> <summary>Determines whether the current immutable set is a proper (strict) superset of the specified collection.</summary> <param name="other">The collection to compare to the current set.</param> <returns> <see langword="true" /> if the current set is a proper superset of the specified collection; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.IsSubsetOf(System.Collections.Generic.IEnumerable{`0})"> <summary>Determines whether the current immutable set is a subset of a specified collection.</summary> <param name="other">The collection to compare to the current set.</param> <returns> <see langword="true" /> if the current set is a subset of the specified collection; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.IsSupersetOf(System.Collections.Generic.IEnumerable{`0})"> <summary>Determines whether the current immutable set is a superset of a specified collection.</summary> <param name="other">The collection to compare to the current set.</param> <returns> <see langword="true" /> if the current set is a superset of the specified collection; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Overlaps(System.Collections.Generic.IEnumerable{`0})"> <summary>Determines whether the current immutable set overlaps with the specified collection.</summary> <param name="other">The collection to compare to the current set.</param> <returns> <see langword="true" /> if the current set and the specified collection share at least one common element; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Remove(`0)"> <summary>Removes the specified element from this immutable set.</summary> <param name="value">The element to remove.</param> <returns>A new set with the specified element removed, or the current set if the element cannot be found in the set.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.SetEquals(System.Collections.Generic.IEnumerable{`0})"> <summary>Determines whether the current immutable set and the specified collection contain the same elements.</summary> <param name="other">The collection to compare to the current set.</param> <returns> <see langword="true" /> if the sets are equal; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.SymmetricExcept(System.Collections.Generic.IEnumerable{`0})"> <summary>Creates an immutable set that contains only elements that are present either in the current set or in the specified collection, but not both.</summary> <param name="other">The collection to compare to the current set.</param> <returns>A new set that contains the elements that are present only in the current set or in the specified collection, but not both.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.TryGetValue(`0,`0@)"> <summary>Determines whether the set contains a specified value.</summary> <param name="equalValue">The value to search for.</param> <param name="actualValue">The matching value from the set, if found, or <c>equalvalue</c> if there are no matches.</param> <returns> <see langword="true" /> if a matching value was found; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableSet`1.Union(System.Collections.Generic.IEnumerable{`0})"> <summary>Creates a new immutable set that contains all elements that are present in either the current set or in the specified collection.</summary> <param name="other">The collection to add elements from.</param> <returns>A new immutable set with the items added; or the original set if all the items were already in the set.</returns> </member> <member name="T:System.Collections.Immutable.IImmutableStack`1"> <summary>Represents an immutable last-in-first-out (LIFO) collection. NuGet package: System.Collections.Immutable (about immutable collections and how to install)</summary> <typeparam name="T">The type of elements in the stack.</typeparam> </member> <member name="M:System.Collections.Immutable.IImmutableStack`1.Clear"> <summary>Removes all objects from the immutable stack.</summary> <returns>An empty immutable stack.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableStack`1.Peek"> <summary>Returns the element at the top of the immutable stack without removing it.</summary> <exception cref="T:System.InvalidOperationException">The stack is empty.</exception> <returns>The element at the top of the stack.</returns> </member> <member name="M:System.Collections.Immutable.IImmutableStack`1.Pop"> <summary>Removes the element at the top of the immutable stack and returns the new stack.</summary> <exception cref="T:System.InvalidOperationException">The stack is empty.</exception> <returns>The new stack; never <see langword="null" /></returns> </member> <member name="M:System.Collections.Immutable.IImmutableStack`1.Push(`0)"> <summary>Inserts an element at the top of the immutable stack and returns the new stack.</summary> <param name="value">The element to push onto the stack.</param> <returns>The new stack.</returns> </member> <member name="P:System.Collections.Immutable.IImmutableStack`1.IsEmpty"> <summary>Gets a value that indicates whether this immutable stack is empty.</summary> <returns> <see langword="true" /> if this stack is empty; otherwise,<see langword="false" />.</returns> </member> <member name="T:System.Collections.Immutable.ImmutableArray"> <summary>Provides methods for creating an array that is immutable; meaning it cannot be changed once it is created. NuGet package: System.Collections.Immutable (about immutable collections and how to install)</summary> </member> <member name="M:System.Collections.Immutable.ImmutableArray.BinarySearch``1(System.Collections.Immutable.ImmutableArray{``0},``0)"> <summary>Searches the sorted immutable array for a specified element using the default comparer and returns the zero-based index of the element, if it's found.</summary> <param name="array">The sorted array to search.</param> <param name="value">The object to search for.</param> <typeparam name="T">The type of element stored in the array.</typeparam> <exception cref="T:System.InvalidOperationException"> <paramref name="value" /> does not implement <see cref="T:System.IComparable" /> or the search encounters an element that does not implement <see cref="T:System.IComparable" />.</exception> <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.BinarySearch``1(System.Collections.Immutable.ImmutableArray{``0},``0,System.Collections.Generic.IComparer{``0})"> <summary>Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it's found.</summary> <param name="array">The sorted array to search.</param> <param name="value">The object to search for.</param> <param name="comparer">The comparer implementation to use when comparing elements, or null to use the default comparer.</param> <typeparam name="T">The type of element stored in the array.</typeparam> <exception cref="T:System.InvalidOperationException"> <paramref name="comparer" /> is null and <paramref name="value" /> does not implement <see cref="T:System.IComparable" /> or the search encounters an element that does not implement <see cref="T:System.IComparable" />.</exception> <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.BinarySearch``1(System.Collections.Immutable.ImmutableArray{``0},System.Int32,System.Int32,``0)"> <summary>Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it's found.</summary> <param name="array">The sorted array to search.</param> <param name="index">The starting index of the range to search.</param> <param name="length">The length of the range to search.</param> <param name="value">The object to search for.</param> <typeparam name="T">The type of element stored in the array.</typeparam> <exception cref="T:System.InvalidOperationException"> <paramref name="value" /> does not implement <see cref="T:System.IComparable" /> or the search encounters an element that does not implement <see cref="T:System.IComparable" />.</exception> <exception cref="T:System.ArgumentException"> <paramref name="index" /> and <paramref name="length" /> do not specify a valid range in <paramref name="array" />.</exception> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="index" /> is less than the lower bound of <paramref name="array" />. -or- <paramref name="length" /> is less than zero.</exception> <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.BinarySearch``1(System.Collections.Immutable.ImmutableArray{``0},System.Int32,System.Int32,``0,System.Collections.Generic.IComparer{``0})"> <summary>Searches a sorted immutable array for a specified element and returns the zero-based index of the element.</summary> <param name="array">The sorted array to search.</param> <param name="index">The starting index of the range to search.</param> <param name="length">The length of the range to search.</param> <param name="value">The object to search for.</param> <param name="comparer">The comparer to use when comparing elements for equality or <see langword="null" /> to use the default comparer.</param> <typeparam name="T">The type of element stored in the array.</typeparam> <exception cref="T:System.InvalidOperationException"> <paramref name="comparer" /> is null and <paramref name="value" /> does not implement <see cref="T:System.IComparable" /> or the search encounters an element that does not implement <see cref="T:System.IComparable" />.</exception> <exception cref="T:System.ArgumentException"> <paramref name="index" /> and <paramref name="length" /> do not specify a valid range in <paramref name="array" />. -or- <paramref name="comparer" /> is <see langword="null" />, and <paramref name="value" /> is of a type that is not compatible with the elements of <paramref name="array" />.</exception> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="index" /> is less than the lower bound of <paramref name="array" />. -or- <paramref name="length" /> is less than zero.</exception> <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1"> <summary>Creates an empty immutable array.</summary> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An empty immutable array.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1(``0)"> <summary>Creates an immutable array that contains the specified object.</summary> <param name="item">The object to store in the array.</param> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An immutable array that contains the specified object.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1(``0,``0)"> <summary>Creates an immutable array that contains the specified objects.</summary> <param name="item1">The first object to store in the array.</param> <param name="item2">The second object to store in the array.</param> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An immutable array that contains the specified objects.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1(``0,``0,``0)"> <summary>Creates an immutable array that contains the specified objects.</summary> <param name="item1">The first object to store in the array.</param> <param name="item2">The second object to store in the array.</param> <param name="item3">The third object to store in the array.</param> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An immutable array that contains the specified objects.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1(``0,``0,``0,``0)"> <summary>Creates an immutable array that contains the specified objects.</summary> <param name="item1">The first object to store in the array.</param> <param name="item2">The second object to store in the array.</param> <param name="item3">The third object to store in the array.</param> <param name="item4">The fourth object to store in the array.</param> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An immutable array that contains the specified objects.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1(``0[])"> <summary>Creates an immutable array from the specified array of objects.</summary> <param name="items">The array of objects to populate the array with.</param> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An immutable array that contains the array of items.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1(``0[],System.Int32,System.Int32)"> <summary>Creates an immutable array with specified objects from another array.</summary> <param name="items">The source array of objects.</param> <param name="start">The index of the first element to copy from <paramref name="items" />.</param> <param name="length">The number of elements from <paramref name="items" /> to include in this immutable array.</param> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An immutable array that contains the specified objects from the source array.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.Create``1(System.Collections.Immutable.ImmutableArray{``0},System.Int32,System.Int32)"> <summary>Creates an immutable array with the specified objects from another immutable array.</summary> <param name="items">The source array of objects.</param> <param name="start">The index of the first element to copy from <paramref name="items" />.</param> <param name="length">The number of elements from <paramref name="items" /> to include in this immutable array.</param> <typeparam name="T">The type of elements stored in the array.</typeparam> <returns>An immutable array that contains the specified objects from the source array.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.CreateBuilder``1"> <summary>Creates a mutable array that can be converted to an <see cref="T:System.Collections.Immutable.ImmutableArray" /> without allocating new memory.</summary> <typeparam name="T">The type of elements stored in the builder.</typeparam> <returns>A mutable array of the specified type that can be efficiently converted to an immutable array.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.CreateBuilder``1(System.Int32)"> <summary>Creates a mutable array that can be converted to an <see cref="T:System.Collections.Immutable.ImmutableArray" /> without allocating new memory.</summary> <param name="initialCapacity">The initial capacity of the builder.</param> <typeparam name="T">The type of elements stored in the builder.</typeparam> <returns>A mutable array of the specified type that can be efficiently converted to an immutable array.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.CreateRange``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Creates a new <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> populated with the specified items.</summary> <param name="items">The elements to add to the array.</param> <typeparam name="T">The type of element stored in the array.</typeparam> <returns>An immutable array that contains the specified items.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.CreateRange``2(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,``1})"> <summary>Initializes a new instance of the <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> struct.</summary> <param name="items">The source array to initialize the resulting array with.</param> <param name="selector">The function to apply to each element from the source array.</param> <typeparam name="TSource">The type of element stored in the source array.</typeparam> <typeparam name="TResult">The type of element to store in the target array.</typeparam> <returns>An immutable array that contains the specified items.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.CreateRange``2(System.Collections.Immutable.ImmutableArray{``0},System.Int32,System.Int32,System.Func{``0,``1})"> <summary>Initializes a new instance of the <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> struct.</summary> <param name="items">The source array to initialize the resulting array with.</param> <param name="start">The index of the first element in the source array to include in the resulting array.</param> <param name="length">The number of elements from the source array to include in the resulting array.</param> <param name="selector">The function to apply to each element from the source array included in the resulting array.</param> <typeparam name="TSource">The type of element stored in the source array.</typeparam> <typeparam name="TResult">The type of element to store in the target array.</typeparam> <returns>An immutable array that contains the specified items.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.CreateRange``3(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,``1,``2},``1)"> <summary>Initializes a new instance of the <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> struct.</summary> <param name="items">The source array to initialize the resulting array with.</param> <param name="selector">The function to apply to each element from the source array.</param> <param name="arg">An argument to be passed to the selector mapping function.</param> <typeparam name="TSource">The type of element stored in the source array.</typeparam> <typeparam name="TArg">The type of argument to pass to the selector mapping function.</typeparam> <typeparam name="TResult">The type of element to store in the target array.</typeparam> <returns>An immutable array that contains the specified items.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.CreateRange``3(System.Collections.Immutable.ImmutableArray{``0},System.Int32,System.Int32,System.Func{``0,``1,``2},``1)"> <summary>Initializes a new instance of the <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> struct.</summary> <param name="items">The source array to initialize the resulting array with.</param> <param name="start">The index of the first element in the source array to include in the resulting array.</param> <param name="length">The number of elements from the source array to include in the resulting array.</param> <param name="selector">The function to apply to each element from the source array included in the resulting array.</param> <param name="arg">An argument to be passed to the selector mapping function.</param> <typeparam name="TSource">The type of element stored in the source array.</typeparam> <typeparam name="TArg">The type of argument to be passed to the selector mapping function.</typeparam> <typeparam name="TResult">The type of element to be stored in the target array.</typeparam> <returns>An immutable array that contains the specified items.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.ToImmutableArray``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Creates an immutable array from the specified collection.</summary> <param name="items">The collection of objects to copy to the immutable array.</param> <typeparam name="TSource">The type of elements contained in <paramref name="items" />.</typeparam> <returns>An immutable array that contains the specified collection of objects.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray.ToImmutableArray``1(System.Collections.Immutable.ImmutableArray{``0}.Builder)"> <summary>Creates an immutable array from the current contents of the builder's array.</summary> <param name="builder">The builder to create the immutable array from.</param> <typeparam name="TSource">The type of elements contained in the immutable array.</typeparam> <returns>An immutable array that contains the current contents of the builder's array.</returns> </member> <member name="T:System.Collections.Immutable.ImmutableArray`1"> <summary>Represents an array that is immutable; meaning it cannot be changed once it is created. NuGet package: System.Collections.Immutable (about immutable collections and how to install)</summary> <typeparam name="T">The type of element stored by the array.</typeparam> </member> <member name="F:System.Collections.Immutable.ImmutableArray`1.Empty"> <summary>Gets an empty immutable array.</summary> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.Add(`0)"> <summary>Returns a copy of the original array with the specified item added to the end.</summary> <param name="item">The item to be added to the end of the array.</param> <returns>A new array with the specified item added to the end.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> <summary>Returns a copy of the original array with the specified elements added to the end of the array.</summary> <param name="items">The elements to add to the array.</param> <returns>A new array with the elements added.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.AddRange(System.Collections.Immutable.ImmutableArray{`0})"> <summary>Returns a copy of the original array with the specified elements added to the end of the array.</summary> <param name="items">The elements to add to the array.</param> <returns>A new array with the elements added.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.As``1"> <summary>Returns a new immutable array that contains the elements of this array cast to a different type.</summary> <typeparam name="TOther">The type of array element to return.</typeparam> <returns>An immutable array that contains the elements of this array, cast to a different type. If the cast fails, returns an array whose <see cref="P:System.Collections.Immutable.ImmutableArray`1.IsDefault" /> property returns <see langword="true" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.AsMemory"> <summary>Creates a new read-only memory region over this immutable array.</summary> <returns>The read-only memory representation of this immutable array.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.AsSpan"> <summary>Creates a new read-only span over this immutable array.</summary> <returns>The read-only span representation of this immutable array.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.CastArray``1"> <summary>Initializes a new instance of the <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> struct by casting the underlying array to an array of type <typeparamref name="TOther" />.</summary> <typeparam name="TOther">The type of array element to return.</typeparam> <exception cref="T:System.InvalidCastException">Thrown if the cast is illegal.</exception> <returns>An immutable array instance with elements cast to the new type.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.CastUp``1(System.Collections.Immutable.ImmutableArray{``0})"> <summary>Initializes a new instance of the <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> struct based on the contents of an existing instance, allowing a covariant static cast to efficiently reuse the existing array.</summary> <param name="items">The array to initialize the array with. No copy is made.</param> <typeparam name="TDerived">The type of array element to return.</typeparam> <returns>An immutable array instance with elements cast to the new type.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.Clear"> <summary>Returns an array with all the elements removed.</summary> <returns>An array with all of the elements removed.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.Contains(`0)"> <summary>Determines whether the specified item exists in the array.</summary> <param name="item">The item to search for.</param> <returns> <see langword="true" /> if the specified item was found in the array; otherwise <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.CopyTo(`0[])"> <summary>Copies the contents of this array to the specified array.</summary> <param name="destination">The array to copy to.</param> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.CopyTo(`0[],System.Int32)"> <summary>Copies the contents of this array to the specified array starting at the specified destination index.</summary> <param name="destination">The array to copy to.</param> <param name="destinationIndex">The index in <paramref name="array" /> where copying begins.</param> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"> <summary>Copies the specified items in this array to the specified array at the specified starting index.</summary> <param name="sourceIndex">The index of this array where copying begins.</param> <param name="destination">The array to copy to.</param> <param name="destinationIndex">The index in <paramref name="array" /> where copying begins.</param> <param name="length">The number of elements to copy from this array.</param> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.Equals(System.Collections.Immutable.ImmutableArray{`0})"> <summary>Indicates whether specified array is equal to this array.</summary> <param name="other">An object to compare with this object.</param> <returns> <see langword="true" /> if <paramref name="other" /> is equal to this array; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.Equals(System.Object)"> <summary>Determines if this array is equal to the specified object.</summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this array.</param> <returns> <see langword="true" /> if this array is equal to <paramref name="obj" />; otherwise, <see langword="false" />.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.GetEnumerator"> <summary>Returns an enumerator that iterates through the contents of the array.</summary> <returns>An enumerator.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.GetHashCode"> <summary>Returns a hash code for this instance.</summary> <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.IndexOf(`0)"> <summary>Searches the array for the specified item.</summary> <param name="item">The item to search for.</param> <returns>The zero-based index position of the item if it is found, or -1 if it is not.</returns> </member> <member name="M:System.Collections.Immutable.ImmutableArray`1.IndexOf(`0,System.Int32)"> <summary>Searches the array for the specified item.</summary> <param name="item">The item to search for.</param>