executil

Documentation

Index

• func CurrentUser() string
• func CurrentUserIs(thisUser string) bool
• func Exec(ctx context.Context, out *string, arg0 string, argv ...string) error
• func WithOpts(ctx context.Context, opts Opts) context.Context
• func WithVerbose(ctx context.Context) context.Context
• type Opts
  • func OptsFromContext(ctx context.Context) Opts

Functions

func CurrentUser

func CurrentUser() string

CurrentUser gets the current user's name. If it fails, then a panic is thrown.

func CurrentUserIs

func CurrentUserIs(thisUser string) bool

CurrentUserIs returns true if the given thisUser's name matches the current username.

func Exec

func Exec(ctx context.Context, out *string, arg0 string, argv ...string) error

Exec executes a command.

func WithOpts

func WithOpts(ctx context.Context, opts Opts) context.Context

WithOpts inserts the given Opts into the context to be used. It overrides the parent Opts, if any.

func WithVerbose

func WithVerbose(ctx context.Context) context.Context

WithVerbose puts all Exec calls using the returned context into verbose mode, meaning stderr will be used.

Types

type Opts

type Opts struct {
	UseSudo  bool
	Username string
}

Opts contains the options to be used during evaluation.

func OptsFromContext

func OptsFromContext(ctx context.Context) Opts

OptsFromContext returns the Opts from the given context.