flow

package module

Go to main page

Versions in this module

v0

v0.1.3

Apr 29, 2024

Changes in this version

+ const TraverseContinue

+ const TraverseEndBranch

+ const TraverseStop

v0.1.2

Apr 18, 2024

Changes in this version

+ type RetryEvent struct

+ Attempt uint64

+ Error error

+ Since time.Duration

type RetryOption

+ NextBackOff func(ctx context.Context, re RetryEvent, nextBackOff time.Duration) time.Duration

v0.1.1

Apr 17, 2024

Changes in this version

+ func Values[M ~map[K]V, K comparable, V any](m M) []V

type AddStep

+ func (as AddStep[S]) Output(fns ...func(context.Context, S) error) AddStep[S]

v0.1.0

Apr 7, 2024

Changes in this version

+ func HasStep(step, target Steper) bool

+ func Has[T Steper](s Steper) bool

type AddSteps

+ func (as AddSteps) AddToWorkflow() map[Steper]*StepConfig

+ type ErrBeforeStep struct

+ func (e ErrBeforeStep) Unwrap() error

type IfBranch

+ func (i *IfBranch[T]) AddToWorkflow() map[Steper]*StepConfig

type State

+ func (s *State) GetStepResult() StepResult

+ type StepResult struct

+ Err error

+ Status StepStatus

+ func (e StepResult) Error() string

+ func (e StepResult) Unwrap() error

type SwitchBranch

+ func (s *SwitchBranch[T]) AddToWorkflow() map[Steper]*StepConfig

+ type TraverseDecision struct

+ Continue bool

+ StopThisBranch bool

+ func Traverse(s Steper, f func(Steper, []Steper) TraverseDecision, walked ...Steper) TraverseDecision

type WorkflowAdder

+ AddToWorkflow func() map[Steper]*StepConfig

v0.0.12

Apr 2, 2024

v0.0.11

Mar 29, 2024

v0.0.10

Mar 15, 2024

Changes in this version

type ErrWithStackTraces

+ func (e ErrWithStackTraces) Unwrap() error

v0.0.9

Mar 12, 2024

v0.0.8

Mar 12, 2024

Changes in this version

+ func DecorateErrorJSON(rerr error, marshal func() ([]byte, error)) ([]byte, error)

+ func WithStackTraces(skip, depth int, ignores ...func(runtime.Frame) bool) func(error) error

type ErrBefore

+ func (e ErrBefore) MarshalJSON() ([]byte, error)

type ErrCancel

+ func (e ErrCancel) MarshalJSON() ([]byte, error)

type ErrPanic

+ func (e ErrPanic) MarshalJSON() ([]byte, error)

type ErrSkip

+ func (e ErrSkip) MarshalJSON() ([]byte, error)

type ErrSucceed

+ func (e ErrSucceed) MarshalJSON() ([]byte, error)

+ type ErrWithStackTraces struct

+ Err error

+ Frames *runtime.Frames

+ Ignores []func(runtime.Frame) bool

+ func (e ErrWithStackTraces) Error() string

+ func (e ErrWithStackTraces) MarshalJSON() ([]byte, error)

+ func (e ErrWithStackTraces) StackTraces() []string

+ type NoOpStep struct

+ Name string

+ func NoOp(name string) *NoOpStep

+ func (*NoOpStep) Do(context.Context) error

+ func (n *NoOpStep) String() string

v0.0.7

Feb 29, 2024

Changes in this version

+ func ConditionOrDefault(cond Condition) func(context.Context, map[Steper]StatusError) StepStatus

+ func IsStep(step, target Steper) bool

+ type BranchCheck struct

+ Check BranchCheckFunc[T]

+ Error error

+ OK bool

+ func (bc *BranchCheck[T]) Do(ctx context.Context, target T)

+ type BranchCheckFunc func(context.Context, T) (bool, error)

+ type IfBranch struct

+ BranchCheck BranchCheck[T]

+ Cond Condition

+ ElseStep []Steper

+ Target T

+ ThenStep []Steper

+ func If[T Steper](target T, check BranchCheckFunc[T]) *IfBranch[T]

+ func (i *IfBranch[T]) Done() map[Steper]*StepConfig

+ func (i *IfBranch[T]) Else(el ...Steper) *IfBranch[T]

+ func (i *IfBranch[T]) Then(th ...Steper) *IfBranch[T]

+ func (i *IfBranch[T]) When(cond Condition) *IfBranch[T]

type Set

+ func (s Set[T]) Flatten() []T

type StepStatus

+ func AnySucceeded(ctx context.Context, ups map[Steper]StatusError) StepStatus

+ type SwitchBranch struct

+ CasesToCheck map[Steper]*BranchCheck[T]

+ Cond Condition

+ DefaultStep []Steper

+ Target T

+ func Switch[T Steper](target T) *SwitchBranch[T]

+ func (s *SwitchBranch[T]) Case(step Steper, check BranchCheckFunc[T]) *SwitchBranch[T]

+ func (s *SwitchBranch[T]) Cases(steps []Steper, check BranchCheckFunc[T]) *SwitchBranch[T]

+ func (s *SwitchBranch[T]) Default(step ...Steper) *SwitchBranch[T]

+ func (s *SwitchBranch[T]) Done() map[Steper]*StepConfig

+ func (s *SwitchBranch[T]) When(cond Condition) *SwitchBranch[T]

type Workflow

+ func (w *Workflow) Reset() error

v0.0.6

Feb 22, 2024

Changes in this version

type Workflow

+ SkipAsError bool

v0.0.5

Feb 22, 2024

Changes in this version

type WorkflowAdder

+ func NameFunc(step Steper, fn func() string) WorkflowAdder

+ func Names(m map[Steper]string) WorkflowAdder

v0.0.4

Feb 21, 2024

Changes in this version

+ type StepBuilder interface

+ BuildStep func()

v0.0.3

Feb 20, 2024

Changes in this version

+ func Keys[M ~map[K]V, K comparable, V any](m M) []K

type AddStep

+ func (as AddStep[S]) AfterStep(afters ...AfterStep) AddStep[S]

+ func (as AddStep[S]) BeforeStep(befores ...BeforeStep) AddStep[S]

type AddSteps

+ func BatchPipe(batch ...AddSteps) AddSteps

+ func (as AddSteps) AfterStep(afters ...AfterStep) AddSteps

+ func (as AddSteps) BeforeStep(befores ...BeforeStep) AddSteps

+ func (as AddSteps) Merge(other AddSteps) AddSteps

+ type AfterStep func(context.Context, Steper, error) error

+ type BeforeStep func(context.Context, Steper) (context.Context, error)

+ type ErrBefore struct

+ func (e ErrBefore) Unwrap() error

+ type ErrUnexpectedStepInitStatus map[Steper]StepStatus

+ func (e ErrUnexpectedStepInitStatus) Error() string

+ type ErrWrappedStepAlreadyInTree struct

+ NewAncestor Steper

+ OldAncestor Steper

+ StepAlreadyThere Steper

+ func (e ErrWrappedStepAlreadyInTree) Error() string

type RetryOption

+ TimeoutPerTry time.Duration

type State

+ func (s *State) After(ctx context.Context, step Steper, err error) error

+ func (s *State) Before(ctx context.Context, step Steper) (context.Context, error)

type StepConfig

+ After AfterStep

+ Before BeforeStep

+ func (sc *StepConfig) AddAfter(after AfterStep)

+ func (sc *StepConfig) AddBefore(before BeforeStep)

type StepStatus

+ func AllSucceededOrSkipped(ctx context.Context, ups map[Steper]StatusError) StepStatus

type Workflow

+ Clock clock.Clock

+ MaxConcurrency int

+ OKToSkip bool

type WorkflowAdder

+ func Mock[T Steper](step T, do func(context.Context) error) WorkflowAdder

+ func Name(step Steper, name string) WorkflowAdder

+ func NameStringer(step Steper, name fmt.Stringer) WorkflowAdder

v0.0.2

Feb 19, 2024

Changes in this version

+ var DefaultRetryOption = RetryOption

+ var ErrWorkflowIsRunning = fmt.Errorf("Workflow is running, please wait for it terminated")

+ var WorkflowPhases = []Phase

+ func As[T Steper](s Steper) []T

+ func DontPanic(w *Workflow)

+ func Is[T Steper](s Steper) bool

+ func LogValue(step Steper) logValue

+ func String(step Steper) string

+ type Adapter struct

+ Flow func(context.Context, S) error

+ Upstream Steper

+ func Adapt[U, D Steper](up U, fn func(context.Context, U, D) error) Adapter[D]

+ type AddStep struct

+ Steps []S

+ func Step[S Steper](steps ...S) AddStep[S]

+ func (as AddStep[S]) DependsOn(ups ...Steper) AddStep[S]

+ func (as AddStep[S]) Input(fns ...func(context.Context, S) error) AddStep[S]

+ func (as AddStep[S]) InputDependsOn(adapts ...Adapter[S]) AddStep[S]

+ func (as AddStep[S]) Retry(fns ...func(*RetryOption)) AddStep[S]

+ func (as AddStep[S]) Timeout(timeout time.Duration) AddStep[S]

+ func (as AddStep[S]) When(when Condition) AddStep[S]

+ type AddSteps map[Steper]*StepConfig

+ func Pipe(steps ...Steper) AddSteps

+ func Steps(steps ...Steper) AddSteps

+ func (as AddSteps) DependsOn(ups ...Steper) AddSteps

+ func (as AddSteps) Done() map[Steper]*StepConfig

+ func (as AddSteps) Retry(opts ...func(*RetryOption)) AddSteps

+ func (as AddSteps) Timeout(timeout time.Duration) AddSteps

+ func (as AddSteps) When(cond Condition) AddSteps

+ type Condition func(ctx context.Context, ups map[Steper]StatusError) StepStatus

+ var DefaultCondition Condition = AllSucceeded

+ var DefaultIsCanceled = func(err error) bool { ... }

+ type ErrCancel struct

+ func Cancel(err error) ErrCancel

+ func (e ErrCancel) Unwrap() error

+ type ErrCycleDependency map[Steper][]Steper

+ func (e ErrCycleDependency) Error() string

+ type ErrInput struct

+ func (e ErrInput) Unwrap() error

+ type ErrPanic struct

+ func (e ErrPanic) Unwrap() error

+ type ErrSkip struct

+ func Skip(err error) ErrSkip

+ func (e ErrSkip) Unwrap() error

+ type ErrSucceed struct

+ func Succeed(err error) ErrSucceed

+ func (e ErrSucceed) Unwrap() error

+ type ErrUnexpectStepInitStatus map[Steper]StepStatus

+ func (e ErrUnexpectStepInitStatus) Error() string

+ type ErrWorkflow map[Steper]StatusError

+ func (e ErrWorkflow) AllSucceeded() bool

+ func (e ErrWorkflow) AllSucceededOrSkipped() bool

+ func (e ErrWorkflow) Error() string

+ func (e ErrWorkflow) MarshalJSON() ([]byte, error)

+ func (e ErrWorkflow) Unwrap() []error

+ type Function struct

+ DoFunc func(context.Context, I) (O, error)

+ Input I

+ Name string

+ Output O

+ func Func(name string, do func(context.Context) error) *Function[struct{}, struct{}]

+ func FuncIO[I, O any](name string, do func(context.Context, I) (O, error)) *Function[I, O]

+ func FuncI[I any](name string, do func(context.Context, I) error) *Function[I, struct{}]

+ func FuncO[O any](name string, do func(context.Context) (O, error)) *Function[struct{}, O]

+ func (f *Function[I, O]) Do(ctx context.Context) error

+ func (f *Function[I, O]) String() string

+ type MockStep struct

+ MockDo func(context.Context) error

+ Step Steper

+ func (m *MockStep) Do(ctx context.Context) error

+ func (m *MockStep) Unwrap() Steper

+ type NamedStep struct

+ Name string

+ func WithName(name string, step Steper) *NamedStep

+ func (ns *NamedStep) String() string

+ func (ns *NamedStep) Unwrap() Steper

+ type NonOpStep struct

+ Name string

+ func (*NonOpStep) Do(context.Context) error

+ func (n *NonOpStep) String() string

+ type Notify struct

+ AfterStep func(ctx context.Context, step Steper, err error)

+ BeforeStep func(ctx context.Context, step Steper) context.Context

+ type Phase string

+ const PhaseDefer

+ const PhaseInit

+ const PhaseMain

+ const PhaseUnknown

+ type RetryOption struct

+ Attempts uint64

+ Backoff backoff.BackOff

+ Notify backoff.Notify

+ StopIf func(ctx context.Context, attempt uint64, since time.Duration, err error) bool

+ Timeout time.Duration

+ Timer backoff.Timer

+ type Set map[T]struct

+ func (s Set[T]) Add(vs ...T)

+ func (s Set[T]) Has(v T) bool

+ func (s Set[T]) Union(sets ...Set[T])

+ type State struct

+ Config *StepConfig

+ func (s *State) AddUpstream(up Steper)

+ func (s *State) GetError() error

+ func (s *State) GetStatus() StepStatus

+ func (s *State) GetStatusError() StatusError

+ func (s *State) Input(ctx context.Context) error

+ func (s *State) MergeConfig(sc *StepConfig)

+ func (s *State) Option() *StepOption

+ func (s *State) SetError(err error)

+ func (s *State) SetStatus(ss StepStatus)

+ func (s *State) Upstreams() Set[Steper]

+ type StatusError struct

+ Err error

+ Status StepStatus

+ func (e StatusError) Error() string

+ func (e StatusError) MarshalJSON() ([]byte, error)

+ func (e StatusError) Unwrap() error

+ type StepConfig struct

+ Input func(context.Context) error

+ Option func(*StepOption)

+ Upstreams Set[Steper]

+ func (sc *StepConfig) AddInput(input func(context.Context) error)

+ func (sc *StepConfig) AddOption(opt func(*StepOption))

+ func (sc *StepConfig) Merge(other *StepConfig)

+ type StepOption struct

+ Condition Condition

+ RetryOption *RetryOption

+ Timeout *time.Duration

+ type StepStatus string

+ const Canceled

+ const Failed

+ const Pending

+ const Running

+ const Skipped

+ const Succeeded

+ func AllSucceeded(ctx context.Context, ups map[Steper]StatusError) StepStatus

+ func Always(context.Context, map[Steper]StatusError) StepStatus

+ func AnyFailed(ctx context.Context, ups map[Steper]StatusError) StepStatus

+ func BeCanceled(ctx context.Context, ups map[Steper]StatusError) StepStatus

+ func StatusFromError(err error) StepStatus

+ func (s StepStatus) IsTerminated() bool

+ func (s StepStatus) String() string

+ type StepTree map[Steper]Steper

+ func (sc StepTree) Add(step Steper) (oldRoots Set[Steper])

+ func (sc StepTree) Roots() Set[Steper]

+ func (st StepTree) IsRoot(step Steper) bool

+ func (st StepTree) RootOf(step Steper) Steper

+ type Steper interface

+ Do func(context.Context) error

+ func ToSteps[S Steper](steps []S) []Steper

+ type StringerNamedStep struct

+ Name fmt.Stringer

+ func (sns *StringerNamedStep) String() string

+ func (sns *StringerNamedStep) Unwrap() Steper

+ type Workflow struct

+ DontPanic bool

+ OkToSkip bool

+ func (s *Workflow) Options(opts ...WorkflowOption) *Workflow

+ func (w *Workflow) Add(was ...WorkflowAdder) *Workflow

+ func (w *Workflow) Defer(was ...WorkflowAdder) *Workflow

+ func (w *Workflow) Do(ctx context.Context) error

+ func (w *Workflow) Empty() bool

+ func (w *Workflow) Init(was ...WorkflowAdder) *Workflow

+ func (w *Workflow) IsPhaseTerminated(phase Phase) bool

+ func (w *Workflow) IsTerminated() bool

+ func (w *Workflow) PhaseAdd(phase Phase, was ...WorkflowAdder) *Workflow

+ func (w *Workflow) PhaseOf(step Steper) Phase

+ func (w *Workflow) RootOf(step Steper) Steper

+ func (w *Workflow) StateOf(step Steper) *State

+ func (w *Workflow) Steps() []Steper

+ func (w *Workflow) Unwrap() []Steper

+ func (w *Workflow) UpstreamOf(step Steper) map[Steper]StatusError

+ type WorkflowAdder interface

+ Done func() map[Steper]*StepConfig

+ type WorkflowOption func(*Workflow)

+ func WithClock(clock clock.Clock) WorkflowOption

+ func WithMaxConcurrency(n int) WorkflowOption

+ func WithNotify(notify Notify) WorkflowOption

v0.0.1-alpha4

Jan 31, 2024

v0.0.1-alpha3

Jan 30, 2024

v0.0.1-alpha2

Jan 3, 2024

v0.0.1-alpha1

Dec 23, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL