flag

Documentation

Overview

Package flag provides flags support for uconfig

Index

• Constants
• func IsCommand(f flat.Field) bool
• func New(name string, errorHandling ErrorHandling, args []string) plugins.Plugin
• func Standard() plugins.Plugin
• type ErrorHandling

Constants

const (
	ContinueOnError = ErrorHandling(flag.ContinueOnError)
	ExitOnError     = ErrorHandling(flag.ExitOnError)
	PanicOnError    = ErrorHandling(flag.PanicOnError)
)

These constants cause FlagSet.Parse to behave as described if the parse fails.

Functions

func IsCommand

func IsCommand(f flat.Field) bool

Indicates whatever the field is "command" field. Used by usage and maybe used for other plugins to exclude command.

func New

func New(name string, errorHandling ErrorHandling, args []string) plugins.Plugin

New returns a new Flags

func Standard

func Standard() plugins.Plugin

Standard returns a set of flags configured in the common way. It is same as: `New(os.Args[0], ContinueOnError, os.Args[1:])`

Types

type ErrorHandling

type ErrorHandling flag.ErrorHandling

ErrorHandling defines how FlagSet.Parse behaves if the parse fails.