languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-09-06 00:59:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mention iteration depth for some Iterable methods

Browse source 
Closes #7797

Most of the other suggestions have already been added, add an explicit
mention of shorcutting for `contains`, `firstWhere`, and `single`,

R=lrn@google.com

Change-Id: I53c254839f198a368fcb8734c3f7983b9b3ccad4
CoreLibraryReviewExempt: Doc changes only.
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/310767
Reviewed-by: Lasse Nielsen <lrn@google.com>
Commit-Queue: Nate Bosch <nbosch@google.com>
This commit is contained in:
Nate Bosch 2023-06-22 20:44:09 +00:00 committed by Commit Queue
parent b9bcfa7004
commit 1837435273
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
sdk/lib/core/iterable.dart
View file

@ -306,6 +306,7 @@ abstract mixin class Iterable<E> {
/// This operation will check each element in order for being equal to
/// [element], unless it has a more efficient way to find an element
/// equal to [element].
/// Stops iterating on the first equal element.
///
/// The equality used to determine whether [element] is equal to an element of
/// the iterable defaults to the [Object.==] of the element.
@ -665,6 +666,7 @@ abstract mixin class Iterable<E> {
/// Checks that this iterable has only one element, and returns that element.
///
/// Throws a [StateError] if `this` is empty or has more than one element.
/// This operation will not iterate past the second element.
E get single {
Iterator<E> it = iterator;
if (!it.moveNext()) throw IterableElementError.noElement();
@ -689,6 +691,7 @@ abstract mixin class Iterable<E> {
/// If no element satisfies [test], the result of invoking the [orElse]
/// function is returned.
/// If [orElse] is omitted, it defaults to throwing a [StateError].
/// Stops iterating on the first matching element.
E firstWhere(bool test(E element), {E orElse()?}) {
for (E element in this) {
if (test(element)) return element;