go-stream

module

v1.0.0 Latest Latest Go to latest Published: Mar 4, 2023 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Lazy stream to work with slices wich will be calculated only when terminal function called or during the wrapping

Method	Functionality
`New[V any](slice ...V) Stream[V]`	create stream instance
`Wrap[V any, NV any](s Stream[V], wrapValue WrapValueFunc[V, NV]) Stream[NV]`	execute stream, convert it's values to the new type and creates stream of new type
`Join[V any, W any, VW any, K comparable](sLeft Stream[V], extractKeyLeft ExtractComparableKeyFunc[V, K], sRight Stream[W], extractKeyRight ExtractComparableKeyFunc[W, K], merge MergeValuesFunc[V, W, VW]) Stream[VW]`	join to streams and creates stream of new type based on mapping

Method	Functionality
`Sort(sortValues SortFunc[V]) Stream[V]`	sort values with function
`Filter(checkValues FilterFunc[V]) Stream[V]`	filter values with function
`Peek(peekValues PeekFunc[V]) Stream[V]`	peek values with function
`Limit(int) Stream[V]`	limit values to number
`Skip(int) Stream[V]`	skip values from number
`Distinct(compareValues EqFunc[V]) Stream[V]`	remove duplicates using funcition to compare
`DistinctByKey(compareValues ExtractKeyFunc[V]) Stream[V]`	remove duplicates using funcition to create key
`Expand(remap ExpandFunc[V]) Stream[V]`	expand value element to a slice of values
`Reverse() Stream[V]`	reverse slice order

Method	Functionality
`Get() []V`	get values
`ForEach(do DoFunc[V]) error`	do for each synchronously
`ForEachAsync(do DoFunc[V]) error`	do for each asynchronously
`ForEachChunk(chunkSize int, do DoChunkFunc[V]) error`	do for each chunk of size synchronously
`ForEachChunkAsync(chunkSize int, do DoChunkFunc[V]) error`	do for each chunk of size asynchronously
`Count() int`	get amount of values
`First() (V, bool)`	get first value (true if exists)
`FirstBy(checkValues FilterFunc[V]) (int, V, bool)`	get first value that is satisfying condition func returns index, value and if exists (true if exists)
`Last() (V, bool)`	get last value (true if exists)
`LastBy(checkValues FilterFunc[V]) (int, V, bool)`	get last value that is satisfying condition func returns index, value and if exists (true if exists)
`AllMatch(checkValues FilterFunc[V]) bool`	check if all matches condition function
`AnyMatch(checkValues FilterFunc[V]) bool`	check if any matches condition function
`NoneMatch(checkValues FilterFunc[V]) bool`	check if none matches condition function

Path	Synopsis
pkg
stream