AsyncEnumerableExtensionsSumAsync(IAsyncEnumerableBinarySize, CancellationToken) Method

Asynchronously computes the sum of a sequence of BinarySize values.

Definition

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

C#

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

VB

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

C++

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

F#

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

Parameters

source IAsyncEnumerableBinarySize: A sequence of BinarySize values to calculate the sum of.
cancellationToken CancellationToken (Optional): The optional cancellation token to be used for canceling the sequence at any time.

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 IAsyncEnumerableBinarySize. 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 is .
OverflowException	The sum is larger than BinarySizeMaxValue.