Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jub0bs/iterutil
an experimental collection of utility functions (sources, combinators, sinks) for working with Go iterators
https://github.com/jub0bs/iterutil
combinators functional-programming functions generics generics-in-golang go golang iterator
Last synced: 30 days ago
JSON representation
an experimental collection of utility functions (sources, combinators, sinks) for working with Go iterators
- Host: GitHub
- URL: https://github.com/jub0bs/iterutil
- Owner: jub0bs
- License: mit
- Created: 2024-09-13T14:00:37.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-03T08:41:31.000Z (2 months ago)
- Last Synced: 2024-10-03T14:05:12.587Z (2 months ago)
- Topics: combinators, functional-programming, functions, generics, generics-in-golang, go, golang, iterator
- Language: Go
- Homepage: https://pkg.go.dev/github.com/jub0bs/iterutil
- Size: 81.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - jub0bs/iterutil - an experimental collection of utility functions (sources, combinators, sinks) for working with Go iterators (Go)
README
# jub0bs/iterutil
[](https://github.com/jub0bs/iterutil/releases)
[](https://pkg.go.dev/github.com/jub0bs/iterutil)
[](https://github.com/jub0bs/iterutil/raw/main/LICENSE)
[](https://github.com/jub0bs/iterutil/actions/workflows/iterutil.yml)
[](https://app.codecov.io/gh/jub0bs/iterutil/tree/main)
[](https://goreportcard.com/report/jub0bs/iterutil)
An experimental collection of utility functions (sources, combinators, sinks)
for working with [Go][golang] [iterators].
## Installation
```shell
go get github.com/jub0bs/iterutil
```
jub0bs/iterutil requires Go 1.23 or above.
## Documentation
The documentation is available on [pkg.go.dev][pkgsite].
## Code coverage
## License
All source code is covered by the [MIT License][license].
## FAQ
### What inspired this library?
- [Haskell][haskell]'s [prelude][prelude]
- the [slices][slices] and [maps][maps] packages
- https://github.com/golang/go/issues/61898
### Can I depend on this library?
You can, but at your own peril.
At this early stage, I reserve the right, upon new releases, to break the API:
some functions may see their names, signatures, and/or behaviors change,
and some functions may be removed altogether.
If you need a few functions from this library but do not want to depend on it,
feel free to copy their sources in your project;
[a little copying is better than a little dependency][copying].
### How should I use this library?
Above all, use it with parsimony.
Chaining many combinators is far from ideal for several reasons:
- code readability may suffer, in part
because Go's idiosyncracies hinder "[fluent chaining][fluent]" and
because Go lacks a concise notation for anonymous functions;
- a more classic and imperative style is likely to prove more performant;
- Go lacks the powerful [laziness][lazy] of [Haskell][haskell].
Bear in mind that the existence of this library is no license
to overuse combinator chaining in your codebase!
[copying]: https://www.youtube.com/watch?v=PAAkCSZUG1c&t=568s
[fluent]: https://en.wikipedia.org/wiki/Fluent_interface
[golang]: https://go.dev/
[haskell]: https://www.haskell.org/
[iterators]: https://go.dev/blog/range-functions
[lazy]: https://en.wikipedia.org/wiki/Lazy_evaluation
[license]: https://github.com/jub0bs/iterutil/blob/main/LICENSE
[maps]: https://pkg.go.dev/maps
[pkgsite]: https://pkg.go.dev/github.com/jub0bs/iterutil
[prelude]: https://downloads.haskell.org/ghc/9.8.2/docs/libraries/base-4.19.1.0-179c/Prelude.html
[slices]: https://pkg.go.dev/slices