tasks

Documentation

Index

• func Add[TaskArg any, TaskReturn any](ts *Tasks, name string, taskFunc TaskFunc[TaskArg, TaskReturn])
• type CleanupFunc
• type Logger
  • func NewTasksLogger(ctx context.Context, mode LoggerMode) (*Logger, error)
  • func (l *Logger) AddEntry(name string) *LoggerEntry
  • func (l *Logger) CloseAndWait() error
  • func (l *Logger) Write(s *buildkit.SolveStatus)
• type LoggerEntry
• type LoggerMode
• type Task
  • func (t *Task) AddToCleanUp(cleanupFunc CleanupFunc)
• type TaskFunc
• type Tasks
  • func Begin() *Tasks
  • func (ts *Tasks) Cleanup(ctx context.Context, logger *Logger, failed int)
  • func (ts *Tasks) Execute(ctx context.Context, data interface{}) (interface{}, error)
  • func (ts *Tasks) SetLoggerMode(mode LoggerMode)

Functions

func Add

func Add[TaskArg any, TaskReturn any](ts *Tasks, name string, taskFunc TaskFunc[TaskArg, TaskReturn])

Types

type CleanupFunc

type CleanupFunc func(ctx context.Context) error

type Logger

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

func NewTasksLogger

func NewTasksLogger(ctx context.Context, mode LoggerMode) (*Logger, error)

func (*Logger) AddEntry

func (l *Logger) AddEntry(name string) *LoggerEntry

func (*Logger) CloseAndWait

func (l *Logger) CloseAndWait() error

func (*Logger) Write

func (l *Logger) Write(s *buildkit.SolveStatus)

type LoggerEntry

type LoggerEntry struct {
	Logs *os.File

	Start    func()
	Complete func(err error)
}

type LoggerMode

type LoggerMode string

const (
	PrinterModeQuiet LoggerMode = "quiet"
	PrinterModeAuto  LoggerMode = "auto"
	PrinterModeTty   LoggerMode = "tty"
)

type Task

type Task struct {
	Name string
	Ctx  context.Context
	Logs *os.File
	// contains filtered or unexported fields
}

func (*Task) AddToCleanUp

func (t *Task) AddToCleanUp(cleanupFunc CleanupFunc)

type TaskFunc

type TaskFunc[T any, U any] func(t *Task, args T) (nextArgs U, err error)

type Tasks

type Tasks struct {
	LoggerMode LoggerMode
	// contains filtered or unexported fields
}

func Begin

func Begin() *Tasks

func (*Tasks) Cleanup

func (ts *Tasks) Cleanup(ctx context.Context, logger *Logger, failed int)

Cleanup execute all tasks cleanup function before failed one in reverse order

func (*Tasks) Execute

func (ts *Tasks) Execute(ctx context.Context, data interface{}) (interface{}, error)

Execute tasks with interactive display and cleanup on fail

func (*Tasks) SetLoggerMode

func (ts *Tasks) SetLoggerMode(mode LoggerMode)