fx

Documentation

Index

• Variables
• func DoWithRetry(fn func() error, opts ...RetryOption) error
• func DoWithTimeout(fn func() error, timeout time.Duration, opts ...DoOption) error
• func Parallel(fns ...func())
• type DoOption
  • func WithContext(ctx context.Context) DoOption
• type FilterFunc
• type ForAllFunc
• type ForEachFunc
• type GenerateFunc
• type KeyFunc
• type LessFunc
• type MapFunc
• type Option
  • func UnlimitedWorkers() Option
  • func WithWorkers(workers int) Option
• type ParallelFunc
• type ReduceFunc
• type RetryOption
  • func WithRetry(times int) RetryOption
• type Stream
  • func From(generate GenerateFunc) Stream
  • func Just(items ...interface{}) Stream
  • func Range(source <-chan interface{}) Stream
  • func (p Stream) Buffer(n int) Stream
  • func (p Stream) Count() (count int)
  • func (p Stream) Distinct(fn KeyFunc) Stream
  • func (p Stream) Done()
  • func (p Stream) Filter(fn FilterFunc, opts ...Option) Stream
  • func (p Stream) ForAll(fn ForAllFunc)
  • func (p Stream) ForEach(fn ForEachFunc)
  • func (p Stream) Group(fn KeyFunc) Stream
  • func (p Stream) Head(n int64) Stream
  • func (p Stream) Map(fn MapFunc, opts ...Option) Stream
  • func (p Stream) Merge() Stream
  • func (p Stream) Parallel(fn ParallelFunc, opts ...Option)
  • func (p Stream) Reduce(fn ReduceFunc) (interface{}, error)
  • func (p Stream) Reverse() Stream
  • func (p Stream) Sort(less LessFunc) Stream
  • func (p Stream) Split(n int) Stream
  • func (p Stream) Tail(n int64) Stream
  • func (p Stream) Walk(fn WalkFunc, opts ...Option) Stream
• type WalkFunc

Variables

var (
	// ErrCanceled is the error returned when the context is canceled.
	ErrCanceled = context.Canceled
	// ErrTimeout is the error returned when the context's deadline passes.
	ErrTimeout = context.DeadlineExceeded
)

Functions

func DoWithRetry

func DoWithRetry(fn func() error, opts ...RetryOption) error

DoWithRetry runs fn, and retries if failed. Default to retry 3 times.

func DoWithTimeout

func DoWithTimeout(fn func() error, timeout time.Duration, opts ...DoOption) error

DoWithTimeout runs fn with timeout control.

func Parallel

func Parallel(fns ...func())

Parallel runs fns parallelly and waits for done.

Types

type DoOption

type DoOption func() context.Context

DoOption defines the method to customize a DoWithTimeout call.

func WithContext

func WithContext(ctx context.Context) DoOption

WithContext customizes a DoWithTimeout call with given ctx.

type FilterFunc

type FilterFunc func(item interface{}) bool

FilterFunc defines the method to filter a Stream.

type ForAllFunc

type ForAllFunc func(pipe <-chan interface{})

ForAllFunc defines the method to handle all elements in a Stream.

type ForEachFunc

type ForEachFunc func(item interface{})

ForEachFunc defines the method to handle each element in a Stream.

type GenerateFunc

type GenerateFunc func(source chan<- interface{})

GenerateFunc defines the method to send elements into a Stream.

type KeyFunc

type KeyFunc func(item interface{}) interface{}

KeyFunc defines the method to generate keys for the elements in a Stream.

type LessFunc

type LessFunc func(a, b interface{}) bool

LessFunc defines the method to compare the elements in a Stream.

type MapFunc

type MapFunc func(item interface{}) interface{}

MapFunc defines the method to map each element to another object in a Stream.

type Option

type Option func(opts *rxOptions)

Option defines the method to customize a Stream.

func UnlimitedWorkers

func UnlimitedWorkers() Option

UnlimitedWorkers lets the caller to use as many workers as the tasks.

func WithWorkers

func WithWorkers(workers int) Option

WithWorkers lets the caller to customize the concurrent workers.

type ParallelFunc

type ParallelFunc func(item interface{})

ParallelFunc defines the method to handle elements parallelly.

type ReduceFunc

type ReduceFunc func(pipe <-chan interface{}) (interface{}, error)

ReduceFunc defines the method to reduce all the elements in a Stream.

type RetryOption

type RetryOption func(*retryOptions)

RetryOption defines the method to customize DoWithRetry.

func WithRetry

func WithRetry(times int) RetryOption

WithRetry customize a DoWithRetry call with given retry times.

type Stream

type Stream struct {
	// contains filtered or unexported fields
}

A Stream is a stream that can be used to do stream processing.

func From

func From(generate GenerateFunc) Stream

From constructs a Stream from the given GenerateFunc.

func Just

func Just(items ...interface{}) Stream

Just converts the given arbitrary items to a Stream.

func Range

func Range(source <-chan interface{}) Stream

Range converts the given channel to a Stream.

func (Stream) Buffer

func (p Stream) Buffer(n int) Stream

Buffer buffers the items into a queue with size n. It can balance the producer and the consumer if their processing throughput don't match.

func (Stream) Count

func (p Stream) Count() (count int)

Count counts the number of elements in the result.

func (Stream) Distinct

func (p Stream) Distinct(fn KeyFunc) Stream

Distinct removes the duplicated items base on the given KeyFunc.

func (Stream) Done

func (p Stream) Done()

Done waits all upstreaming operations to be done.

func (Stream) Filter

func (p Stream) Filter(fn FilterFunc, opts ...Option) Stream

Filter filters the items by the given FilterFunc.

func (Stream) ForAll

func (p Stream) ForAll(fn ForAllFunc)

ForAll handles the streaming elements from the source and no later streams.

func (Stream) ForEach

func (p Stream) ForEach(fn ForEachFunc)

ForEach seals the Stream with the ForEachFunc on each item, no successive operations.

func (Stream) Group

func (p Stream) Group(fn KeyFunc) Stream

Group groups the elements into different groups based on their keys.

func (Stream) Head

func (p Stream) Head(n int64) Stream

Head returns the first n elements in p.

func (Stream) Map

func (p Stream) Map(fn MapFunc, opts ...Option) Stream

Map converts each item to another corresponding item, which means it's a 1:1 model.

func (Stream) Merge

func (p Stream) Merge() Stream

Merge merges all the items into a slice and generates a new stream.

func (Stream) Parallel

func (p Stream) Parallel(fn ParallelFunc, opts ...Option)

Parallel applies the given ParallelFunc to each item concurrently with given number of workers.

func (Stream) Reduce

func (p Stream) Reduce(fn ReduceFunc) (interface{}, error)

Reduce is a utility method to let the caller deal with the underlying channel.

func (Stream) Reverse

func (p Stream) Reverse() Stream

Reverse reverses the elements in the stream.

func (Stream) Sort

func (p Stream) Sort(less LessFunc) Stream

Sort sorts the items from the underlying source.

func (Stream) Split

func (p Stream) Split(n int) Stream

Split splits the elements into chunk with size up to n, might be less than n on tailing elements.

func (Stream) Tail

func (p Stream) Tail(n int64) Stream

Tail returns the last n elements in p.

func (Stream) Walk

func (p Stream) Walk(fn WalkFunc, opts ...Option) Stream

Walk lets the callers handle each item, the caller may write zero, one or more items base on the given item.

type WalkFunc

type WalkFunc func(item interface{}, pipe chan<- interface{})

WalkFunc defines the method to walk through all the elements in a Stream.