AsyncEnumerable.ToDictionaryAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
ToDictionaryAsync<TKey,TValue>(IAsyncEnumerable<KeyValuePair<TKey,TValue>>, IEqualityComparer<TKey>, CancellationToken)
- Source:
- ToDictionaryAsync.cs
Creates a Dictionary<TKey,TValue> from an IAsyncEnumerable<T> according to specified key comparer.
public static System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<TKey,TValue>> ToDictionaryAsync<TKey,TValue>(this System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<TKey,TValue>> source, System.Collections.Generic.IEqualityComparer<TKey>? comparer = default, System.Threading.CancellationToken cancellationToken = default);static member ToDictionaryAsync : System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<'Key, 'Value>> * System.Collections.Generic.IEqualityComparer<'Key> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<'Key, 'Value>><Extension()>
Public Function ToDictionaryAsync(Of TKey, TValue) (source As IAsyncEnumerable(Of KeyValuePair(Of TKey, TValue)), Optional comparer As IEqualityComparer(Of TKey) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Dictionary(Of TKey, TValue))Type Parameters
- TKey
The type of the keys from elements of source
- TValue
The type of the values from elements of source
Parameters
- source
- IAsyncEnumerable<KeyValuePair<TKey,TValue>>
The IAsyncEnumerable<T> to create a Dictionary<TKey,TValue> from.
- comparer
- IEqualityComparer<TKey>
An IEqualityComparer<T> to compare keys.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
A Dictionary<TKey,TValue> that contains keys and values from source.
Exceptions
source is null.
source contains one or more duplicate keys (via the returned task).
Applies to
ToDictionaryAsync<TKey,TValue>(IAsyncEnumerable<ValueTuple<TKey,TValue>>, IEqualityComparer<TKey>, CancellationToken)
- Source:
- ToDictionaryAsync.cs
Creates a Dictionary<TKey,TValue> from an IAsyncEnumerable<T> according to specified key comparer.
public static System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<TKey,TValue>> ToDictionaryAsync<TKey,TValue>(this System.Collections.Generic.IAsyncEnumerable<(TKey Key, TValue Value)> source, System.Collections.Generic.IEqualityComparer<TKey>? comparer = default, System.Threading.CancellationToken cancellationToken = default);static member ToDictionaryAsync : System.Collections.Generic.IAsyncEnumerable<ValueTuple<'Key, 'Value>> * System.Collections.Generic.IEqualityComparer<'Key> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<'Key, 'Value>><Extension()>
Public Function ToDictionaryAsync(Of TKey, TValue) (source As IAsyncEnumerable(Of ValueTuple(Of TKey, TValue)), Optional comparer As IEqualityComparer(Of TKey) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Dictionary(Of TKey, TValue))Type Parameters
- TKey
The type of the keys from elements of source
- TValue
The type of the values from elements of source
Parameters
- source
- IAsyncEnumerable<ValueTuple<TKey,TValue>>
The IAsyncEnumerable<T> to create a Dictionary<TKey,TValue> from.
- comparer
- IEqualityComparer<TKey>
An IEqualityComparer<T> to compare keys.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
A Dictionary<TKey,TValue> that contains keys and values from source.
Exceptions
source is null.
source contains one or more duplicate keys (via the returned task).
Applies to
ToDictionaryAsync<TSource,TKey,TElement>(IAsyncEnumerable<TSource>, Func<TSource,CancellationToken,ValueTask<TKey>>, Func<TSource, CancellationToken,ValueTask<TElement>>, IEqualityComparer<TKey>, CancellationToken)
- Source:
- ToDictionaryAsync.cs
Creates a Dictionary<TKey,TValue> from an IAsyncEnumerable<T>"/> according to specified key selector and element selector functions.
public static System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<TKey,TElement>> ToDictionaryAsync<TSource,TKey,TElement>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<TKey>> keySelector, Func<TSource,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<TElement>> elementSelector, System.Collections.Generic.IEqualityComparer<TKey>? comparer = default, System.Threading.CancellationToken cancellationToken = default);static member ToDictionaryAsync : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<'Key>> * Func<'Source, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<'Element>> * System.Collections.Generic.IEqualityComparer<'Key> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<'Key, 'Element>><Extension()>
Public Function ToDictionaryAsync(Of TSource, TKey, TElement) (source As IAsyncEnumerable(Of TSource), keySelector As Func(Of TSource, CancellationToken, ValueTask(Of TKey)), elementSelector As Func(Of TSource, CancellationToken, ValueTask(Of TElement)), Optional comparer As IEqualityComparer(Of TKey) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Dictionary(Of TKey, TElement))Type Parameters
- TSource
The type of the elements of source.
- TKey
The type of the key returned by keySelector.
- TElement
The type of the value returned by elementSelector.
Parameters
- source
- IAsyncEnumerable<TSource>
An IAsyncEnumerable<T> to create a Dictionary<TKey,TValue> from.
- keySelector
- Func<TSource,CancellationToken,ValueTask<TKey>>
A function to extract a key from each element.
- elementSelector
- Func<TSource,CancellationToken,ValueTask<TElement>>
A transform function to produce a result element value from each element.
- comparer
- IEqualityComparer<TKey>
An IEqualityComparer<T> to compare keys.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
A Dictionary<TKey,TValue> that contains values of type TElement selected from the input sequence.
Exceptions
elementSelector is null.
source contains one or more duplicate keys (via the returned task).
Applies to
ToDictionaryAsync<TSource,TKey,TElement>(IAsyncEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>, CancellationToken)
- Source:
- ToDictionaryAsync.cs
Creates a Dictionary<TKey,TValue> from an IAsyncEnumerable<T>"/> according to specified key selector and element selector functions.
public static System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<TKey,TElement>> ToDictionaryAsync<TSource,TKey,TElement>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,TKey> keySelector, Func<TSource,TElement> elementSelector, System.Collections.Generic.IEqualityComparer<TKey>? comparer = default, System.Threading.CancellationToken cancellationToken = default);static member ToDictionaryAsync : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, 'Key> * Func<'Source, 'Element> * System.Collections.Generic.IEqualityComparer<'Key> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<'Key, 'Element>><Extension()>
Public Function ToDictionaryAsync(Of TSource, TKey, TElement) (source As IAsyncEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), elementSelector As Func(Of TSource, TElement), Optional comparer As IEqualityComparer(Of TKey) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Dictionary(Of TKey, TElement))Type Parameters
- TSource
The type of the elements of source.
- TKey
The type of the key returned by keySelector.
- TElement
The type of the value returned by elementSelector.
Parameters
- source
- IAsyncEnumerable<TSource>
An IAsyncEnumerable<T> to create a Dictionary<TKey,TValue> from.
- keySelector
- Func<TSource,TKey>
A function to extract a key from each element.
- elementSelector
- Func<TSource,TElement>
A transform function to produce a result element value from each element.
- comparer
- IEqualityComparer<TKey>
An IEqualityComparer<T> to compare keys.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
A Dictionary<TKey,TValue> that contains values of type TElement selected from the input sequence.
Exceptions
elementSelector is null.
source contains one or more duplicate keys (via the returned task).
Applies to
ToDictionaryAsync<TSource,TKey>(IAsyncEnumerable<TSource>, Func<TSource, CancellationToken,ValueTask<TKey>>, IEqualityComparer<TKey>, CancellationToken)
- Source:
- ToDictionaryAsync.cs
Creates a Dictionary<TKey,TValue> from an IAsyncEnumerable<T> according to a specified key selector function.
public static System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<TKey,TSource>> ToDictionaryAsync<TSource,TKey>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<TKey>> keySelector, System.Collections.Generic.IEqualityComparer<TKey>? comparer = default, System.Threading.CancellationToken cancellationToken = default);static member ToDictionaryAsync : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<'Key>> * System.Collections.Generic.IEqualityComparer<'Key> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<'Key, 'Source>><Extension()>
Public Function ToDictionaryAsync(Of TSource, TKey) (source As IAsyncEnumerable(Of TSource), keySelector As Func(Of TSource, CancellationToken, ValueTask(Of TKey)), Optional comparer As IEqualityComparer(Of TKey) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Dictionary(Of TKey, TSource))Type Parameters
- TSource
The type of the elements of source.
- TKey
The type of the keys returned by keySelector.
Parameters
- source
- IAsyncEnumerable<TSource>
An IAsyncEnumerable<T> to create a Dictionary<TKey,TValue> from.
- keySelector
- Func<TSource,CancellationToken,ValueTask<TKey>>
A function to extract a key from each element.
- comparer
- IEqualityComparer<TKey>
An IEqualityComparer<T> to compare keys.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
A Dictionary<TKey,TValue> that contains keys and values.
Exceptions
keySelector is null.
source contains one or more duplicate keys (via the returned task).
Applies to
ToDictionaryAsync<TSource,TKey>(IAsyncEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>, CancellationToken)
- Source:
- ToDictionaryAsync.cs
Creates a Dictionary<TKey,TValue> from an IAsyncEnumerable<T> according to a specified key selector function.
public static System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<TKey,TSource>> ToDictionaryAsync<TSource,TKey>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,TKey> keySelector, System.Collections.Generic.IEqualityComparer<TKey>? comparer = default, System.Threading.CancellationToken cancellationToken = default);static member ToDictionaryAsync : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, 'Key> * System.Collections.Generic.IEqualityComparer<'Key> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Collections.Generic.Dictionary<'Key, 'Source>><Extension()>
Public Function ToDictionaryAsync(Of TSource, TKey) (source As IAsyncEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), Optional comparer As IEqualityComparer(Of TKey) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Dictionary(Of TKey, TSource))Type Parameters
- TSource
The type of the elements of source.
- TKey
The type of the keys returned by keySelector.
Parameters
- source
- IAsyncEnumerable<TSource>
An IAsyncEnumerable<T> to create a Dictionary<TKey,TValue> from.
- keySelector
- Func<TSource,TKey>
A function to extract a key from each element.
- comparer
- IEqualityComparer<TKey>
An IEqualityComparer<T> to compare keys.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
A Dictionary<TKey,TValue> that contains keys and values.
Exceptions
keySelector is null.
source contains one or more duplicate keys (via the returned task).
