flow

README

flow

✨ xuender/flow is a ...

🚀 Install

go install gitee.com/xuender/flow@latest

💡 Usage

TODO

Flow Operation

• Chain
• Parallel

Intermediate Operations

• Filter
• FlatMap
• Limit
• Map
• Peek
• Reverse
• Skip
• Sort
• Unique

Terminal Operations

• seq.Count
• seq.Each
• seq.First
• seq.Max
• seq.Min
• seq.Sum
• seq.Join

Seq Operations

• seq.Chan
• seq.Emit
• seq.Range
• seq.Filter
• seq.FlatMap
• seq.Limit
• seq.Map
• seq.Peek
• seq.Reverse
• seq.Skip
• seq.Sort
• seq.Unique

👤 Contributors

📝 License

© ender, 2024~time.Now

MIT LICENSE

Documentation

Index

• func Chain[E any](seq iter.Seq[E], steps ...Step[E, E]) iter.Seq[E]
• func Parallel[E any](size int, items iter.Seq[E], steps ...Step[E, E]) iter.Seq[E]
• type Step
  • func Filter[E any](predicate func(E) bool) Step[E, E]
  • func FlatMap[S ~[]E, E any]() Step[S, E]
  • func Limit[E any](limit int) Step[E, E]
  • func Map[I, O any](mappger func(I) O) Step[I, O]
  • func Peek[E any](action func(E)) Step[E, E]
  • func Reverse[E any]() Step[E, E]
  • func Skip[E any](num int) Step[E, E]
  • func Sort[E cmp.Ordered]() Step[E, E]
  • func Unique[E comparable]() Step[E, E]

Examples

• Chain
• Parallel

Functions

func Chain

func Chain[E any](seq iter.Seq[E], steps ...Step[E, E]) iter.Seq[E]

Example

package main

import (
	"fmt"

	"gitee.com/xuender/flow"
	"gitee.com/xuender/flow/seq"
)

func main() {
	fmt.Println(seq.Max(flow.Chain(
		seq.Range(100),
		flow.Limit[int](3),
		flow.Filter(func(num int) bool { return num%2 == 0 }),
	)))

}

Output:

2 true

func Parallel

func Parallel[E any](size int, items iter.Seq[E], steps ...Step[E, E]) iter.Seq[E]

Example

package main

import (
	"fmt"

	"gitee.com/xuender/flow"
	"gitee.com/xuender/flow/seq"
)

func main() {
	for num := range flow.Parallel(
		2,
		seq.Range(100),
		flow.Limit[int](3),
		flow.Filter(func(num int) bool { return num%3 == 0 }),
	) {
		fmt.Println(num)
	}

}

Output:

0
3

Types

type Step

type Step[I, O any] func(iter.Seq[I]) iter.Seq[O]

func Filter

func Filter[E any](predicate func(E) bool) Step[E, E]

func FlatMap

func FlatMap[S ~[]E, E any]() Step[S, E]

func Limit

func Limit[E any](limit int) Step[E, E]

func Map

func Map[I, O any](mappger func(I) O) Step[I, O]

func Peek

func Peek[E any](action func(E)) Step[E, E]

func Reverse

func Reverse[E any]() Step[E, E]

func Skip

func Skip[E any](num int) Step[E, E]

func Sort

func Sort[E cmp.Ordered]() Step[E, E]

func Unique

func Unique[E comparable]() Step[E, E]