util

Documentation

Index

• func CommandWithResult(ctx context.Context, logger *log.Logger, command *Command) (output string, err error)
• func FilterArgs(args []string, filter []string, ignore bool) (filtered []string)
• func FilterArgsKeep(args []string, filter []string) (filtered []string)
• func FilterArgsRemove(args []string, filter []string) (filtered []string)
• func Flags(cmd any) (args []string)
• func FormatToGoObject(object any) string
• func Pretty(object any) string
• func PrettyPrint(object any)
• func Set[T comparable](s []T) map[T]bool
• func UniqueDirectory(path string) (uniquePath string, err error)
• func UniqueName(name string, existsFunction func(candidate string) (bool, error)) (uniqueName string, err error)
• type Command
• type Parallel
  • func NewParallel(maxWorkers uint) *Parallel
  • func (p *Parallel) Execute(f func())
  • func (p *Parallel) Wait()

Functions

func CommandWithResult

func CommandWithResult(ctx context.Context, logger *log.Logger, command *Command) (output string, err error)

CommandWithResult executes a command and returns its output, while printing the same output to the given logger.

func FilterArgs

func FilterArgs(args []string, filter []string, ignore bool) (filtered []string)

FilterArgs filters the arguments by either ignoring/allowing them in the result.

func FilterArgsKeep

func FilterArgsKeep(args []string, filter []string) (filtered []string)

FilterArgsKeep filters the given argument list and only returns arguments defined present in "filter".

func FilterArgsRemove

func FilterArgsRemove(args []string, filter []string) (filtered []string)

FilterArgsRemove filters the given argument list and returns arguments where "filter" entries are removed.

func Flags

func Flags(cmd any) (args []string)

Flags returns a list of `long` flags bound on the command or nil.

func FormatToGoObject

func FormatToGoObject(object any) string

FormatToGoObject formats the given object to equivalent Go code.

func Pretty

func Pretty(object any) string

Pretty pretty prints the given object to a string.

func PrettyPrint

func PrettyPrint(object any)

PrettyPrint pretty prints the given object to STDOUT.

func Set

func Set[T comparable](s []T) map[T]bool

Set creates a set from a slice.

func UniqueDirectory

func UniqueDirectory(path string) (uniquePath string, err error)

UniqueDirectory creates a unique directory from the given path.

func UniqueName

func UniqueName(name string, existsFunction func(candidate string) (bool, error)) (uniqueName string, err error)

UniqueName creates an unique name.

Types

type Command

type Command struct {
	// Command holds the command with its optional arguments.
	Command []string
	// Stdin holds a string which is passed on as STDIN.
	Stdin string

	// Directory defines the directory the execution should run in, without changing the working directory of the caller.
	Directory string
	// Env overwrites the environment variables of the executed command.
	Env map[string]string
}

Command defines a command that should be executed.

type Parallel

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

Parallel holds a buffered channel for limiting parallel executions.

func NewParallel

func NewParallel(maxWorkers uint) *Parallel

NewParallel returns a Parallel execution helper.

func (*Parallel) Execute

func (p *Parallel) Execute(f func())

Execute runs the given function while checking for a execution limit.

func (*Parallel) Wait

func (p *Parallel) Wait()

Wait waits until all executions are done.