starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-06-16 10:34:26 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Remove incorrectly placed index methods on Collection (#1681)

Browse Source 
These methods aren't implemented in `Set`, and don't really make sense because `Set` types can't be accessed by index.

Note: although this removes methods, this actually isn't a breaking change:
1. Calling `Set.findIndex()` currently throws an error around "cannot invoke abstract method"
2. `List` and `Set` are the only subclasses of `Collection`.

The following code isn't breaking at runtime, although static analysis tooling (like our IDE plugins) will now flag this as an error:

```pkl
myCollection: Collection

idx = myCollection.indexOf(1)
```
This commit is contained in:
Daniel Chao
2026-06-15 08:56:55 -07:00
committed by GitHub
parent a9c98e4396
commit fc8fe86e5a
1 changed files with 54 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stdlib/base.pkl
+54 -66
View File
@@ -2547,36 +2547,6 @@ abstract external class Collection<out Element> extends Any {
predicate: (Element) -> Boolean,
): Pair<Collection<Element>, Collection<Element>>
/// The zero-based index of the first occurrence of [element] in this collection.
///
/// Throws if this collection does not contains [element].
///
/// Facts:
/// ```
/// List(1, 2, 3).indexOf(2) == 1
/// List(1, 2, 2).indexOf(2) == 1
/// import("pkl:test").catch(() -> List(1, 2, 3).indexOf(4))
/// ```
abstract function indexOf(element: Any): Int
/// Same as [indexOf()] but returns [null] if this collection does not contain [element].
abstract function indexOfOrNull(element: Any): Int?
/// The zero-based index of the last occurrence of [element] in this collection.
///
/// Throws if this collection does not contain [element].
///
/// Facts:
/// ```
/// List(1, 2, 3).lastIndexOf(2) == 1
/// List(1, 2, 2).lastIndexOf(2) == 2
/// import("pkl:test").catch(() -> List(1, 2, 3).lastIndexOf(4))
/// ```
abstract function lastIndexOf(element: Any): Int
/// Same as [lastIndexOf()] but returns [null] if this collection does not contain [element].
abstract function lastIndexOfOrNull(element: Any): Int?
/// The first element for which [predicate] returns [true].
///
/// Throws if [predicate] does not hold for any element in this collection.
@@ -2609,42 +2579,6 @@ abstract external class Collection<out Element> extends Any {
/// collection.
abstract function findLastOrNull(predicate: (Element) -> Boolean): Element?
/// The index of the first element for which [predicate] returns [true].
///
/// Throws if [predicate] does not hold for any element in this collection.
///
/// Facts:
/// ```
/// List(5, 6, 7).findIndex((n) -> n.isEven) == 1
/// List(4, 6, 8).findIndex((n) -> n.isEven) == 0
/// import("pkl:test").catch(() -> List(5, 7, 9).findLast((n) -> n.isEven))
/// ```
@AlsoKnownAs { names { "indexWhere" } }
abstract function findIndex(predicate: (Element) -> Boolean): Int
/// Same as [findIndex()] but returns [null] if [predicate] does not hold for any element in this
/// collection.
@AlsoKnownAs { names { "indexWhere" } }
abstract function findIndexOrNull(predicate: (Element) -> Boolean): Int?
/// The index of the last element for which [predicate] returns [true].
///
/// Throws if [predicate] does not hold for any element in this collection.
///
/// Facts:
/// ```
/// List(5, 6, 7).findLastIndex((n) -> n.isEven) == 1
/// List(4, 6, 8).findLastIndex((n) -> n.isEven) == 2
/// import("pkl:test").catch(() -> List(5, 7, 9).findLastIndex((n) -> n.isEven))
/// ```
@AlsoKnownAs { names { "lastIndexWhere" } }
abstract function findLastIndex(predicate: (Element) -> Boolean): Int
/// Same as [findLastIndex()] but returns [null] if [predicate] does not hold for any element in
/// this collection.
@AlsoKnownAs { names { "lastIndexWhere" } }
abstract function findLastIndexOrNull(predicate: (Element) -> Boolean): Int?
/// The number of elements for which [predicate] returns [true].
///
/// Facts:
@@ -3317,16 +3251,70 @@ external class List<out Element> extends Collection<Element> {
external function findLast(predicate: (Element) -> Boolean): Element
external function findLastOrNull(predicate: (Element) -> Boolean): Element?
/// The index of the first element for which [predicate] returns [true].
///
/// Throws if [predicate] does not hold for any element in this collection.
///
/// Facts:
/// ```
/// List(5, 6, 7).findIndex((n) -> n.isEven) == 1
/// List(4, 6, 8).findIndex((n) -> n.isEven) == 0
/// import("pkl:test").catch(() -> List(5, 7, 9).findLast((n) -> n.isEven))
/// ```
@AlsoKnownAs { names { "indexWhere" } }
external function findIndex(predicate: (Element) -> Boolean): Int
/// Same as [findIndex()] but returns [null] if [predicate] does not hold for any element in this
/// collection.
@AlsoKnownAs { names { "indexWhere" } }
external function findIndexOrNull(predicate: (Element) -> Boolean): Int?
/// The index of the last element for which [predicate] returns [true].
///
/// Throws if [predicate] does not hold for any element in this collection.
///
/// Facts:
/// ```
/// List(5, 6, 7).findLastIndex((n) -> n.isEven) == 1
/// List(4, 6, 8).findLastIndex((n) -> n.isEven) == 2
/// import("pkl:test").catch(() -> List(5, 7, 9).findLastIndex((n) -> n.isEven))
/// ```
@AlsoKnownAs { names { "lastIndexWhere" } }
external function findLastIndex(predicate: (Element) -> Boolean): Int
/// Same as [findLastIndex()] but returns [null] if [predicate] does not hold for any element in
/// this collection.
@AlsoKnownAs { names { "lastIndexWhere" } }
external function findLastIndexOrNull(predicate: (Element) -> Boolean): Int?
/// The zero-based index of the first occurrence of [element] in this collection.
///
/// Throws if this collection does not contains [element].
///
/// Facts:
/// ```
/// List(1, 2, 3).indexOf(2) == 1
/// List(1, 2, 2).indexOf(2) == 1
/// import("pkl:test").catch(() -> List(1, 2, 3).indexOf(4))
/// ```
external function indexOf(element: Any): Int
/// Same as [indexOf()] but returns [null] if this collection does not contain [element].
external function indexOfOrNull(element: Any): Int?
/// The zero-based index of the last occurrence of [element] in this collection.
///
/// Throws if this collection does not contain [element].
///
/// Facts:
/// ```
/// List(1, 2, 3).lastIndexOf(2) == 1
/// List(1, 2, 2).lastIndexOf(2) == 2
/// import("pkl:test").catch(() -> List(1, 2, 3).lastIndexOf(4))
/// ```
external function lastIndexOf(element: Any): Int
/// Same as [lastIndexOf()] but returns [null] if this collection does not contain [element].
external function lastIndexOfOrNull(element: Any): Int?
external function count(predicate: (Element) -> Boolean): Int