https://github.com/xuender/go-stream
Stream Collections for Go. Inspired in Java 8 Streams
https://github.com/xuender/go-stream
go go-stream golang stream stream-api
Last synced: 2 months ago
JSON representation
Stream Collections for Go. Inspired in Java 8 Streams
- Host: GitHub
- URL: https://github.com/xuender/go-stream
- Owner: xuender
- License: mit
- Created: 2018-10-21T13:39:56.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-08-14T01:42:35.000Z (almost 2 years ago)
- Last Synced: 2025-02-09T19:40:54.417Z (4 months ago)
- Topics: go, go-stream, golang, stream, stream-api
- Language: Go
- Homepage:
- Size: 126 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# go-stream
[![GoCI][action-svg]][action-url]
[![Go Report Card][goreport-svg]][goreport-url]
[![codecov][codecov-svg]][codecov-url]
[![GoDoc][godoc-svg]][godoc-url]
[![GitHub license][license-svg]][license-url]
[![GitHub issues][issues-svg]][issues-url]
[![GitHub stars][stars-svg]][stars-url]
Stream Collections for Go. Inspired in Java 8 Streams.
Use channel and Go1.18+ generic support.
✨ **`xuender/go-stream` is a Java 8 Streams style Go library based on Go 1.18+ Generics.**
## 🚀 Install
To install the library and command line program:
```shell
go get -u github.com/xuender/go-stream@latest
```
## 💡 Usage
You can import `stream` using:
```go
import "github.com/xuender/go-stream"
```
### NewBase
New BaseStream.
```go
package main
import (
"fmt"
"github.com/xuender/go-stream"
)
func main() {
base := stream.NewBase(stream.Range2Channel(5)).
Peek(func(num int) { fmt.Println("peek1:", num) }).
Filter(func(num int) bool { return num > 2 }).
Peek(func(num int) { fmt.Println("peek2:", num) })
fmt.Println(base.Count())
}
```
Output:
```shell
peek1: 0
peek1: 1
peek1: 2
peek1: 3
peek1: 4
peek2: 3
peek2: 4
2
```
[[play](https://go.dev/play/p/LxULGyhWCi7)]
### Parallel
BaseStream to ParallelStream.
```go
package main
import (
"fmt"
"math/rand"
"time"
"github.com/xuender/go-stream"
)
func main() {
stream.NewBase(stream.Range2Channel(1000)).
Parallel(100).
Filter(func(num int) bool { return num%7 == 0 }).
ForEach(func(num int) {
dur := time.Duration(rand.Intn(1000)) * time.Millisecond
time.Sleep(dur)
fmt.Printf("%d\t%s\n", num, dur)
})
}
```
Output:
```shell
623 2ms
497 2ms
273 15ms
252 26ms
616 33ms
756 10ms
91 47ms
7 59ms
21 59ms
602 59ms
350 78ms
28 81ms
...
```
[[play](https://go.dev/play/p/S23mcPB_URv)]
### Map
Integer to string.
```go
package main
import (
"fmt"
"github.com/xuender/go-stream"
)
func main() {
base := stream.Map(
stream.Range2Channel(100),
func(num int) string { return fmt.Sprintf("[%d]", num) },
).Limit(3)
for i := range base.C {
fmt.Println(i)
}
}
```
Output:
```shell
[0]
[1]
[2]
```
[[play](https://go.dev/play/p/5QlT-D-Cv3V)]
### FlatMap
```go
package main
import (
"fmt"
"github.com/xuender/go-stream"
)
func main() {
stream.FlatMap(
stream.Slice2Channel([]int{0, 0}, []int{1, 2}, []int{2, 4}),
func(num int) string { return fmt.Sprintf("[%d]", num) },
).ForEach(func(str string) {
fmt.Println(str)
})
}
```
Output:
```shell
[0]
[0]
[1]
[2]
[2]
[4]
```
[[play](https://go.dev/play/p/HXeeZOOkD2y)]
### Sorted
OrderedStream sorted.
```go
package main
import (
"fmt"
"github.com/xuender/go-stream"
)
func main() {
stream.NewOrdered(stream.Slice2Channel(3, 2, 7, 1)).
Sorted().
ForEach(func(num int) {
fmt.Println(num)
})
}
```
Output:
```shell
1
2
3
7
```
[[play](https://go.dev/play/p/mSrDBfV_-d1)]
## 🛩 Functions
| Function | Type | State |
| - | - | - |
| AnyMatch | Terminal operations, short-circuiting | √ |
| AllMatch | Terminal operations, short-circuiting | √ |
| Count | Terminal operations | √ |
| Filter | Intermediate operations, Parallel | √ |
| FindFirst | Terminal operations, short-circuiting | √ |
| ForEach | Terminal operations, Parallel | √ |
| Limit | Intermediate operations | √ |
| NoneMatch | Terminal operations, short-circuiting | √ |
| Parallel | Intermediate operations | √ |
| Peek | Intermediate operations, Parallel | √ |
| Skip | Intermediate operations | √ |
| Sort | Intermediate operations | √ |
| Distinct | Intermediate operations, Comparable | √ |
| Max | Terminal operations, Ordered | √ |
| Min | Terminal operations, Ordered | √ |
| Reduce | Terminal operations, Ordered | √ |
| Sorted | Intermediate operations, Ordered | √ |
| Sequential | Intermediate operations, Parallel | √ |
| Map | Function | √ |
| FlatMap | Function | √ |
## 📝 License
© ender, 2023~time.Now
[MIT LICENSE](https://github.com/xuender/go-stream/blob/master/LICENSE)
[action-url]: https://github.com/xuender/go-stream/actions
[action-svg]: https://github.com/xuender/go-stream/workflows/Go/badge.svg
[goreport-url]: https://goreportcard.com/report/github.com/xuender/go-stream
[goreport-svg]: https://goreportcard.com/badge/github.com/xuender/go-stream
[codecov-url]: https://codecov.io/gh/xuender/go-stream
[codecov-svg]: https://codecov.io/gh/xuender/go-stream/branch/master/graph/badge.svg?token=KCNTIM7DLH
[godoc-url]: https://pkg.go.dev/github.com/xuender/go-stream
[godoc-svg]: https://godoc.org/github.com/xuender/go-stream?status.svg
[license-url]: https://github.com/xuender/go-stream/blob/main/LICENSE
[license-svg]: https://img.shields.io/github/license/xuender/go-stream
[issues-url]: https://github.com/xuender/go-stream/issues
[issues-svg]: https://img.shields.io/github/issues/xuender/go-stream
[stars-url]: https://github.com/xuender/gostream/stargazers
[stars-svg]: https://img.shields.io/github/stars/xuender/go-stream