step

Documentation

Overview

Generic Concurrency primitives.

Index

• func After[T any, F func(T)](s *Step[T], f F)
• func Zero[T any]() (zero T)
• type Step
  • func New[T any, F func() (T, bool)](ctx context.Context, f F) *Step[T]
  • func Then[T, U any, F func(T) (U, bool)](s *Step[T], f F) *Step[U]
  • func (s *Step[T]) GetResult() (T, bool)
  • func (s *Step[T]) TryGetResult() (T, bool)

Functions

func After

func After[T any, F func(T)](s *Step[T], f F)

Run a computation after a Step has succeeded.

func Zero

func Zero[T any]() (zero T)

Zero returns the zero value for a type.

Types

type Step

type Step[T any] struct {
	// contains filtered or unexported fields
}

Step represents a computation that may produce a value. This is equivalent to a `Future` in other languages.

func New

func New[T any, F func() (T, bool)](ctx context.Context, f F) *Step[T]

Create a new Step not predicated on any other step. `f` is the computation that the step represents. The second return value indicates if the computation succeeded.

func Then

func Then[T, U any, F func(T) (U, bool)](s *Step[T], f F) *Step[U]

Chain a step (if it succeeded) into another step.

func (*Step[T]) GetResult

func (s *Step[T]) GetResult() (T, bool)

Block on retrieving the computed result. If the computation is canceled, Zero[T](), false is returned.

func (*Step[T]) TryGetResult

func (s *Step[T]) TryGetResult() (T, bool)

A non-blocking attempt to retrieve the value produced by the Step. The bool is true if a computed value is returned. False indicates that the attempt failed.