AsyncEnumerable.TakeWhile Method

Definition

Namespace:

System.Linq

Assembly:

System.Linq.AsyncEnumerable.dll

Package:

System.Linq.AsyncEnumerable v10.0.0-preview.1.25080.5

Overloads

TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,Boolean>)	Returns elements from a sequence as long as a specified condition is true.
TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,Int32,Boolean>)	Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.
TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,Int32,CancellationToken,ValueTask<Boolean>>)	Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.
TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,CancellationToken,ValueTask<Boolean>>)	Returns elements from a sequence as long as a specified condition is true.

TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,Boolean>)

Source:

TakeWhile.cs

Returns elements from a sequence as long as a specified condition is true.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Generic::IAsyncEnumerable<TSource> ^ TakeWhile(System::Collections::Generic::IAsyncEnumerable<TSource> ^ source, Func<TSource, bool> ^ predicate);

public static System.Collections.Generic.IAsyncEnumerable<TSource> TakeWhile<TSource>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,bool> predicate);

static member TakeWhile : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, bool> -> System.Collections.Generic.IAsyncEnumerable<'Source>

<Extension()>
Public Function TakeWhile(Of TSource) (source As IAsyncEnumerable(Of TSource), predicate As Func(Of TSource, Boolean)) As IAsyncEnumerable(Of TSource)

Type Parameters

TSource

The type of the elements of source.

Parameters

source

IAsyncEnumerable<TSource>

A sequence to return elements from.

predicate

Func<TSource,Boolean>

A function to test each element for a condition.

Returns

IAsyncEnumerable<TSource>

An IAsyncEnumerable<T> that contains the elements from the input sequence that occur before the element at which the test no longer passes.

Exceptions

ArgumentNullException

predicate is null.

TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,Int32,Boolean>)

Source:

TakeWhile.cs

Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Generic::IAsyncEnumerable<TSource> ^ TakeWhile(System::Collections::Generic::IAsyncEnumerable<TSource> ^ source, Func<TSource, int, bool> ^ predicate);

public static System.Collections.Generic.IAsyncEnumerable<TSource> TakeWhile<TSource>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,int,bool> predicate);

static member TakeWhile : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, int, bool> -> System.Collections.Generic.IAsyncEnumerable<'Source>

<Extension()>
Public Function TakeWhile(Of TSource) (source As IAsyncEnumerable(Of TSource), predicate As Func(Of TSource, Integer, Boolean)) As IAsyncEnumerable(Of TSource)

Type Parameters

TSource

The type of the elements of source.

Parameters

source

IAsyncEnumerable<TSource>

A sequence to return elements from.

predicate

Func<TSource,Int32,Boolean>

A function to test each element for a condition.

Returns

IAsyncEnumerable<TSource>

An IAsyncEnumerable<T> that contains the elements from the input sequence that occur before the element at which the test no longer passes.

Exceptions

ArgumentNullException

predicate is null.

TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,Int32,CancellationToken,ValueTask<Boolean>>)

Source:

TakeWhile.cs

Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Generic::IAsyncEnumerable<TSource> ^ TakeWhile(System::Collections::Generic::IAsyncEnumerable<TSource> ^ source, Func<TSource, int, System::Threading::CancellationToken, System::Threading::Tasks::ValueTask<bool>> ^ predicate);

public static System.Collections.Generic.IAsyncEnumerable<TSource> TakeWhile<TSource>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,int,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<bool>> predicate);

static member TakeWhile : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, int, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<bool>> -> System.Collections.Generic.IAsyncEnumerable<'Source>

<Extension()>
Public Function TakeWhile(Of TSource) (source As IAsyncEnumerable(Of TSource), predicate As Func(Of TSource, Integer, CancellationToken, ValueTask(Of Boolean))) As IAsyncEnumerable(Of TSource)

Type Parameters

TSource

The type of the elements of source.

Parameters

source

IAsyncEnumerable<TSource>

A sequence to return elements from.

predicate

Func<TSource,Int32,CancellationToken,ValueTask<Boolean>>

A function to test each element for a condition.

Returns

IAsyncEnumerable<TSource>

An IAsyncEnumerable<T> that contains the elements from the input sequence that occur before the element at which the test no longer passes.

Exceptions

ArgumentNullException

predicate is null.

TakeWhile<TSource>(IAsyncEnumerable<TSource>, Func<TSource,CancellationToken,ValueTask<Boolean>>)

Source:

TakeWhile.cs

Returns elements from a sequence as long as a specified condition is true.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Generic::IAsyncEnumerable<TSource> ^ TakeWhile(System::Collections::Generic::IAsyncEnumerable<TSource> ^ source, Func<TSource, System::Threading::CancellationToken, System::Threading::Tasks::ValueTask<bool>> ^ predicate);

public static System.Collections.Generic.IAsyncEnumerable<TSource> TakeWhile<TSource>(this System.Collections.Generic.IAsyncEnumerable<TSource> source, Func<TSource,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<bool>> predicate);

static member TakeWhile : System.Collections.Generic.IAsyncEnumerable<'Source> * Func<'Source, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask<bool>> -> System.Collections.Generic.IAsyncEnumerable<'Source>

<Extension()>
Public Function TakeWhile(Of TSource) (source As IAsyncEnumerable(Of TSource), predicate As Func(Of TSource, CancellationToken, ValueTask(Of Boolean))) As IAsyncEnumerable(Of TSource)

Type Parameters

TSource

The type of the elements of source.

Parameters

source

IAsyncEnumerable<TSource>

A sequence to return elements from.

predicate

Func<TSource,CancellationToken,ValueTask<Boolean>>

A function to test each element for a condition.

Returns

IAsyncEnumerable<TSource>

An IAsyncEnumerable<T> that contains the elements from the input sequence that occur before the element at which the test no longer passes.

Exceptions

ArgumentNullException

predicate is null.