AsyncEnumerable.OrderBy 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
| OrderBy<TSource,TKey>(IAsyncEnumerable<TSource>, Func<TSource,CancellationToken,ValueTask<TKey>>, IComparer<TKey>) |
Sorts the elements of a sequence in ascending order. |
| OrderBy<TSource,TKey>(IAsyncEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>) |
Sorts the elements of a sequence in ascending order. |
OrderBy<TSource,TKey>(IAsyncEnumerable<TSource>, Func<TSource,CancellationToken,ValueTask<TKey>>, IComparer<TKey>)
- Source:
- OrderBy.cs
Sorts the elements of a sequence in ascending order.
public static System.Linq.IOrderedAsyncEnumerable<TSource> OrderBy<TSource,TKey>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<TKey>> keySelector, System.Collections.Generic.IComparer<TKey>? comparer = default);static member OrderBy : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<'Key>> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedAsyncEnumerable<'Source><Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IAsyncEnumerable(Of TSource), keySelector As Func(Of TSource, CancellationToken, ValueTask(Of TKey)), Optional comparer As IComparer(Of TKey) = Nothing) As IOrderedAsyncEnumerable(Of TSource)Type Parameters
- TSource
The type of the elements of source.
- TKey
The type of the key returned by keySelector.
Parameters
- source
- IAsyncEnumerable<TSource>
A sequence of values to order.
- keySelector
- Func<TSource,CancellationToken,ValueTask<TKey>>
A function to extract a key from an element.
- comparer
- IComparer<TKey>
An IComparer<T> to compare keys.
Returns
An IAsyncEnumerable<T> whose elements are sorted according to a key.
Exceptions
keySelector is null.
Applies to
OrderBy<TSource,TKey>(IAsyncEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)
- Source:
- OrderBy.cs
Sorts the elements of a sequence in ascending order.
public static System.Linq.IOrderedAsyncEnumerable<TSource> OrderBy<TSource,TKey>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,TKey> keySelector, System.Collections.Generic.IComparer<TKey>? comparer = default);static member OrderBy : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, 'Key> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedAsyncEnumerable<'Source><Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IAsyncEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), Optional comparer As IComparer(Of TKey) = Nothing) As IOrderedAsyncEnumerable(Of TSource)Type Parameters
- TSource
The type of the elements of source.
- TKey
The type of the key returned by keySelector.
Parameters
- source
- IAsyncEnumerable<TSource>
A sequence of values to order.
- keySelector
- Func<TSource,TKey>
A function to extract a key from an element.
- comparer
- IComparer<TKey>
An IComparer<T> to compare keys.
Returns
An IAsyncEnumerable<T> whose elements are sorted according to a key.
Exceptions
keySelector is null.
