stream

type AccumulatorFunc func(identity any, item any) any

type ConsumeFunc func(item any)

type DistinctFunc func(item any) any

type FilterFunc func(item any) bool

type FlatMapFunc func(item any) Stream

type GenerateFunc func(source chan<- any)

type LessFunc func(a, b any) bool

type MapFunc func(item any) any

type MatchFunc FilterFunc

type Option func(s Stream)

type Stream interface {
	// Map applies the given mapper to each item in the stream
	Map(mapper MapFunc, opts ...Option) Stream
	// FlatMap applies the given mapper to each item in the stream
	FlatMap(mapper FlatMapFunc, opts ...Option) Stream
	// Filter filters the stream by the given predicate
	Filter(filter FilterFunc, opts ...Option) Stream
	// Concat concatenates the given streams to the current stream
	Concat(streams []Stream, opts ...Option) Stream
	// Sort sorts the stream by the given less function
	Sort(less LessFunc, opts ...Option) Stream
	// Distinct removes the duplicate items in the stream
	Distinct(distinct DistinctFunc, opts ...Option) Stream
	// Skip skips the first n items in the stream
	Skip(limit int64, opts ...Option) Stream
	// Limit limits the number of items in the stream
	Limit(limit int64, opts ...Option) Stream
	// TakeWhile takes items from the stream while the given predicate is true.
	// The first item that makes the predicate false will stop the stream.
	//
	// This is a short-circuiting terminal operation.
	TakeWhile(match MatchFunc, opts ...Option) Stream
	// DropWhile drops items from the stream while the given predicate is true.
	// The first item that makes the predicate false will start the stream.
	DropWhile(match MatchFunc, opts ...Option) Stream
	// Peek applies the given consumer to each item in the stream
	Peek(consumer ConsumeFunc, opts ...Option) Stream

	// AnyMatch returns true if any item in the stream matches the given predicate, otherwise false.
	// If the stream is empty, false is returned.
	//
	// This is a short-circuiting terminal operation.
	AnyMatch(match MatchFunc, opts ...Option) bool
	// AllMatch returns true if all items in the stream match the given predicate, otherwise false.
	// If the stream is empty, true is returned.
	//
	// This is a short-circuiting terminal operation.
	AllMatch(match MatchFunc, opts ...Option) bool
	// NoneMatch returns true if no item in the stream matches the given predicate, otherwise false.
	// If the stream is empty, true is returned.
	//
	// This is a short-circuiting terminal operation.
	NoneMatch(match MatchFunc, opts ...Option) bool
	// FindFirst returns the first item in the stream.
	// If the stream is empty, nil is returned.
	//
	// If the stream has no encounter order, then any element may be returned.
	//
	// This is a short-circuiting terminal operation.
	FindFirst(opts ...Option) (item any, found bool)
	// Count returns the number of items in the stream.
	// If the count is greater than math.MaxInt64, math.MaxInt64 is returned.
	Count(opts ...Option) int64
	// Reduce reduces the stream to a single value by the given accumulator function.
	Reduce(identity any, accumulator AccumulatorFunc, opts ...Option) any
	// ForEach applies the given consumer to each item in the stream
	ForEach(consumer ConsumeFunc, opts ...Option)
	// ToIfaceSlice returns the stream as a slice of interface{}
	ToIfaceSlice(opts ...Option) []any
	// ApplyOptions applies the given options to the stream
	ApplyOptions(opts ...Option) Stream
	// Collect collects the stream to a supplier of the given type.
	//
	// You usually don't need to set these 3 parameters directly unless you want to customize the collector.
	// Here are some common collectors:
	// - NewToMapCollector
	// - NewToMapWithIgnoreDuplicateCollector
	// - NewToMapCollectorWithDuplicateHandler
	// - NewToSliceCollector
	// - NewJoiningCollector
	// - NewGroupByCollector
	// - NewCountCollector
	// - NewSumCollector
	// - NewAvgCollector
	// - NewMaxCollector
	// - NewMinCollector
	//
	// Please refer to the example in collectors_test.go for more details.
	Collect(
		supplier func() any,
		accumulator func(container, item any),
		finisher func(container any) any,
	) any
	// Close closes the stream
	Close()
}

type SupplierFunc func() any