AsyncEnumerableExtensionsSumAsyncTSource(IAsyncEnumerableTSource, FuncTSource, BinarySize, CancellationToken) Method

Asynchronously computes the sum of a sequence of BinarySize values that are obtained by invoking a transform function on each element of the input sequence.

Definition

Namespace: Ookii
Assembly: Ookii.BinarySize.Async (in Ookii.BinarySize.Async.dll) Version: 1.2.0+20f0bdf981c7baf115c68ccab612b1a031efcb4d

C#

public static ValueTask<BinarySize> SumAsync<TSource>(
	this IAsyncEnumerable<TSource> source,
	Func<TSource, BinarySize> selector,
	CancellationToken cancellationToken = default
)

VB

<ExtensionAttribute>
Public Shared Function SumAsync(Of TSource) ( 
	source As IAsyncEnumerable(Of TSource),
	selector As Func(Of TSource, BinarySize),
	Optional cancellationToken As CancellationToken = Nothing
) As ValueTask(Of BinarySize)

C++

public:
[ExtensionAttribute]
generic<typename TSource>
static ValueTask<BinarySize> SumAsync(
	IAsyncEnumerable<TSource>^ source, 
	Func<TSource, BinarySize>^ selector, 
	CancellationToken cancellationToken = CancellationToken()
)

F#

[<ExtensionAttribute>]
static member SumAsync : 
        source : IAsyncEnumerable<'TSource> * 
        selector : Func<'TSource, BinarySize> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> ValueTask<BinarySize>

Parameters

source IAsyncEnumerableTSource: A sequence of values to calculate the sum of.
selector FuncTSource, BinarySize: A transform function to apply to each element.
cancellationToken CancellationToken (Optional): The optional cancellation token to be used for canceling the sequence at any time.

Type Parameters

TSource: The type of the elements of source.

Return Value

ValueTaskBinarySize
A task that represents the asynchronous operation. The result of the task is the sum of the values in the sequence.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncEnumerableTSource. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

This method returns zero if source contains no elements.

Exceptions

ArgumentNullException	source or selector is .
OverflowException	The sum is larger than BinarySizeMaxValue.