task

package

v1.8.2-0...-f7776fc Latest Latest Go to latest Published: Feb 2, 2024 License: GPL-2.0, GPL-3.0 Imports: 3 Imported by: 0

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

Package task provides primitives to track tasks via contexts.

This section is empty.

This section is empty.

func ErrContext(errp *error, ctx context.Context)

ErrContext adds current task name to error on error return.

To work as intended it should be called under defer like this:

     func myfunc(ctx, ...) (..., err error) {
		ctx = task.Running("doing something")
		defer task.ErrContext(&err, ctx)
		...

Please see lab.nexedi.com/kirr/go123/xerr.Context for semantic details.

func Running(ctx context.Context, name string) context.Context

Running creates new task and returns new context with that task set to current.

func Runningf(ctx context.Context, format string, argv ...interface{}) context.Context

Runningf is Running cousin with formatting support.

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

Task represents currently running operation.

func Current(ctx context.Context) *Task

Current returns current task represented by context.

if there is no current task - it returns nil.

func (t *Task) Name() string

func (t *Task) Parent() *Task

func (t *Task) String() string

String returns string representing whole operational stack.

For example if task "c" is running under task "b" which in turn is running under task "a" - the operational stack will be "a: b: c".

nil Task is represented as "".