Documentation
¶
Index ¶
- Variables
- func Finish(fns ...func() error) error
- func FinishVoid(fns ...func())
- func Map(generate GenerateFunc, mapper MapFunc, opts ...Option) chan interface{}
- func MapReduce(generate GenerateFunc, mapper MapperFunc, reducer ReducerFunc, opts ...Option) (interface{}, error)
- func MapReduceVoid(generate GenerateFunc, mapper MapperFunc, reducer VoidReducerFunc, ...) error
- func MapReduceWithSource(source <-chan interface{}, mapper MapperFunc, reducer ReducerFunc, ...) (interface{}, error)
- func MapVoid(generate GenerateFunc, mapper VoidMapFunc, opts ...Option)
- type AtomicError
- type DoneChan
- type GenerateFunc
- type GenericType
- type MapFunc
- type MapperFunc
- type Option
- type PlaceholderType
- type ProductDetail
- type ReducerFunc
- type VoidMapFunc
- type VoidReducerFunc
- type Writer
Constants ¶
This section is empty.
Variables ¶
var ( // ErrCancelWithNil is an error that mapreduce was cancelled with nil. ErrCancelWithNil = errors.New("mapreduce cancelled with nil") // ErrReduceNoOutput is an error that reduce did not output a value. ErrReduceNoOutput = errors.New("reduce not writing value") )
Functions ¶
func Map ¶
func Map(generate GenerateFunc, mapper MapFunc, opts ...Option) chan interface{}
Map maps all elements generated from given generate func, and returns an output channel.
func MapReduce ¶
func MapReduce(generate GenerateFunc, mapper MapperFunc, reducer ReducerFunc, opts ...Option) (interface{}, error)
MapReduce maps all elements generated from given generate func, and reduces the output elements with given reducer.
func MapReduceVoid ¶
func MapReduceVoid(generate GenerateFunc, mapper MapperFunc, reducer VoidReducerFunc, opts ...Option) error
MapReduceVoid maps all elements generated from given generate, and reduce the output elements with given reducer.
func MapReduceWithSource ¶
func MapReduceWithSource(source <-chan interface{}, mapper MapperFunc, reducer ReducerFunc,
opts ...Option) (interface{}, error)
MapReduceWithSource maps all elements from source, and reduce the output elements with given reducer.
func MapVoid ¶
func MapVoid(generate GenerateFunc, mapper VoidMapFunc, opts ...Option)
MapVoid maps all elements from given generate but no output.
Types ¶
type AtomicError ¶
type AtomicError struct {
// contains filtered or unexported fields
}
AtomicError defines an atomic error.
type DoneChan ¶
type DoneChan struct {
// contains filtered or unexported fields
}
A DoneChan is used as a channel that can be closed multiple times and wait for done.
func (*DoneChan) Close ¶
func (dc *DoneChan) Close()
Close closes dc, it's safe to close more than once.
func (*DoneChan) Done ¶
func (dc *DoneChan) Done() chan PlaceholderType
Done returns a channel that can be notified on dc closed.
type GenerateFunc ¶
type GenerateFunc func(source chan<- interface{})
GenerateFunc is used to let callers send elements into source.
type MapFunc ¶
type MapFunc func(item interface{}, writer Writer)
MapFunc is used to do element processing and write the output to writer.
type MapperFunc ¶
MapperFunc is used to do element processing and write the output to writer, use cancel func to cancel the processing.
type Option ¶
type Option func(opts *mapReduceOptions)
Option defines the method to customize the mapreduce.
func WithContext ¶
WithContext customizes a mapreduce processing accepts a given ctx.
func WithWorkers ¶
WithWorkers customizes a mapreduce processing with given workers.
type PlaceholderType ¶
type PlaceholderType = struct{}
PlaceholderType represents a placeholder type.
var Placeholder PlaceholderType
Placeholder is a placeholder object that can be used globally.
type ProductDetail ¶
type ProductDetail struct {
User interface{}
Store interface{}
Order interface{}
}
type ReducerFunc ¶
ReducerFunc is used to reduce all the mapping output and write to writer, use cancel func to cancel the processing.
type VoidMapFunc ¶
type VoidMapFunc func(item interface{})
VoidMapFunc is used to do element processing, but no output.
type VoidReducerFunc ¶
type VoidReducerFunc func(pipe <-chan interface{}, cancel func(error))
VoidReducerFunc is used to reduce all the mapping output, but no output. Use cancel func to cancel the processing.
Source Files