Click or drag to resize

MoreEnumerableTakeUntilTSource Method

Returns items from the input sequence until the given predicate returns true when applied to the current source item; that item will be the last returned.

Namespace:  MoreLinq
Assembly:  MoreLinq (in MoreLinq.dll) Version: 2.4.0
public static IEnumerable<TSource> TakeUntil<TSource>(
	this IEnumerable<TSource> source,
	Func<TSource, bool> predicate


Type: System.Collections.GenericIEnumerableTSource
Source sequence
Type: SystemFuncTSource, Boolean
Predicate used to determine when to stop yielding results from the source.

Type Parameters

Type of the source sequence

Return Value

Type: IEnumerableTSource
Items from the source sequence, until the predicate returns true when applied to the item.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableTSource. 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).
ArgumentNullExceptionsource or predicate is null

TakeUntil differs from Enumerable.TakeWhile in two respects. Firstly, the sense of the predicate is reversed: it is expected that the predicate will return false to start with, and then return true - for example, when trying to find a matching item in a sequence.

Secondly, TakeUntil yields the element which causes the predicate to return true. For example, in a sequence

{ 1, 2, 3, 4, 5 }
and with a predicate of
x => x == 3
, the result would be
{ 1, 2, 3 }

TakeUntil is as lazy as possible: it will not iterate over the source sequence until it has to, it won't iterate further than it has to, and it won't evaluate the predicate until it has to. (This means that an item may be returned which would actually cause the predicate to throw an exception if it were evaluated, so long as no more items of data are requested.)

See Also