root

Documentation

Index

• type ProfilingOptions
  • func NewProfilingOptions() *ProfilingOptions
  • func (o *ProfilingOptions) AddFlags(flagSet *pflag.FlagSet)
  • func (o *ProfilingOptions) FlushProfiling() error
  • func (o *ProfilingOptions) InitProfiling() error
• type RootOptions
  • func NewCommand(out, errOut io.Writer) (*cobra.Command, *RootOptions)

Types

type ProfilingOptions

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

ProfilingOptions contains settings for profiling.

func NewProfilingOptions

func NewProfilingOptions() *ProfilingOptions

NewProfilingOptions initializes ProfilingOptions with defaults.

func (*ProfilingOptions) AddFlags

func (o *ProfilingOptions) AddFlags(flagSet *pflag.FlagSet)

AddFlags adds flags for setting profiling options to the provided FlagSet.

func (*ProfilingOptions) FlushProfiling

func (o *ProfilingOptions) FlushProfiling() error

FlushProfiling stops profiling and writes remaining unwritten data.

func (*ProfilingOptions) InitProfiling

func (o *ProfilingOptions) InitProfiling() error

InitProfiling starts profiling.

type RootOptions

type RootOptions struct {
	Profiling *ProfilingOptions
	Output    output.Output
}

RootOptions contains options configured in the root command.

func NewCommand

func NewCommand(out, errOut io.Writer) (*cobra.Command, *RootOptions)

NewCommand creates a root command with useful built-in features like: - profiling - version command with different output formats - help command with different output formats - command discovery for use as a CLI plugin.