SergeychWorks/lyng
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects 1 Releases 11 Wiki Activity

more docs on Iterable

Browse Source
This commit is contained in:
Sergey Chernov 2025-08-09 23:20:25 +03:00
parent d3785afa6f
commit ba8d543d87
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Iterable.md
View File

@ -1,5 +1,11 @@
# Iterable interface # Iterable interface
The interface for anything that can be iterated, e.g. finite or infinite ordered set of data that can be accessed sequentially. Almost any data container in `Lyng` implements it: `List`, `Set`, `Buffer`, `RingBuffer`, and many others are `Iterable`, also `Collection` and `Array` interfaces inherit it.
`Map` and `String` have `Iterable` members to access its contents too.
## Definition:
Iterable is a class that provides function that creates _the iterator_: Iterable is a class that provides function that creates _the iterator_:
class Iterable { class Iterable {
@ -26,7 +32,7 @@ Having `Iterable` in base classes allows to use it in for loop. Also, each `Iter
assertEquals( [1,2] r.dropLast(8) ) assertEquals( [1,2] r.dropLast(8) )
>>> void >>> void
## Instance methods ## Instance methods:
| fun/method | description | | fun/method | description |
|-----------------|---------------------------------------------------------------------------------| |-----------------|---------------------------------------------------------------------------------|
@ -60,7 +66,7 @@ Having `Iterable` in base classes allows to use it in for loop. Also, each `Iter
fun Iterable.associateBy( keyMaker: (Any?)->Any): Map fun Iterable.associateBy( keyMaker: (Any?)->Any): Map
## Abstract methods ## Abstract methods:
fun iterator(): Iterator fun iterator(): Iterator