Add descriptive comments to most Go functions

1 files changed, 23 insertions, 0 deletions

diff --git a/iter.go b/iter.go
new file mode 100644
index 0000000..d4c7175
--- /dev/null
+++ b/iter.go
@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
+
+package main
+
+import "iter"
+
+// iterSeqLimit returns an iterator equivalent to the supplied one, but stops
+// after n iterations.
+func iterSeqLimit[T any](s iter.Seq[T], n uint) iter.Seq[T] {
+	return func(yield func(T) bool) {
+		var iterations uint
+		for v := range s {
+			if iterations > n-1 {
+				return
+			}
+			if !yield(v) {
+				return
+			}
+			iterations++
+		}
+	}
+}