flags

package
v0.0.0-...-666a20f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 20, 2022 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EthCategory        = "ETHEREUM"
	LightCategory      = "LIGHT CLIENT"
	DevCategory        = "DEVELOPER CHAIN"
	EthashCategory     = "ETHASH"
	TxPoolCategory     = "TRANSACTION POOL"
	PerfCategory       = "PERFORMANCE TUNING"
	AccountCategory    = "ACCOUNT"
	APICategory        = "API AND CONSOLE"
	NetworkingCategory = "NETWORKING"
	MinerCategory      = "MINER"
	GasPriceCategory   = "GAS PRICE ORACLE"
	VMCategory         = "VIRTUAL MACHINE"
	LoggingCategory    = "LOGGING AND DEBUGGING"
	MetricsCategory    = "METRICS AND STATS"
	MiscCategory       = "MISC"
	DeprecatedCategory = "ALIASED (deprecated)"
)

Variables

This section is empty.

Functions

func FlagString 

func FlagString(f cli.Flag) string

FlagString prints a single flag in help.

func GlobalBig 

func GlobalBig(ctx *cli.Context, name string) *big.Int

GlobalBig returns the value of a BigFlag from the global flag set.

func HomeDir 

func HomeDir() string

func MigrateGlobalFlags 

func MigrateGlobalFlags(ctx *cli.Context)

MigrateGlobalFlags makes all global flag values available in the context. This should be called as early as possible in app.Before.

Example: 

geth account new --keystore /tmp/mykeystore --lightkdf

is equivalent after calling this method with: 

geth --keystore /tmp/mykeystore --lightkdf account new

i.e. in the subcommand Action function of 'account new', ctx.Bool("lightkdf) will return true even if --lightkdf is set as a global option.

This function may become unnecessary when https://github.com/urfave/cli/pull/1245 is merged.

func NewApp 

func NewApp(gitCommit, gitDate, usage string) *cli.App

NewApp creates an app with sane defaults.

Types

type BigFlag 

type BigFlag struct {
	Name string

	Category    string
	DefaultText string
	Usage       string

	Required   bool
	Hidden     bool
	HasBeenSet bool

	Value *big.Int

	Aliases []string
}

BigFlag is a command line flag that accepts 256 bit big integers in decimal or hexadecimal syntax.

func (*BigFlag) Apply 

func (f *BigFlag) Apply(set *flag.FlagSet) error

func (*BigFlag) GetCategory 

func (f *BigFlag) GetCategory() string

func (*BigFlag) GetDefaultText 

func (f *BigFlag) GetDefaultText() string

func (*BigFlag) GetEnvVars 

func (f *BigFlag) GetEnvVars() []string

func (*BigFlag) GetUsage 

func (f *BigFlag) GetUsage() string

func (*BigFlag) GetValue 

func (f *BigFlag) GetValue() string

func (*BigFlag) IsRequired 

func (f *BigFlag) IsRequired() bool

func (*BigFlag) IsSet 

func (f *BigFlag) IsSet() bool

func (*BigFlag) IsVisible 

func (f *BigFlag) IsVisible() bool

func (*BigFlag) Names 

func (f *BigFlag) Names() []string

func (*BigFlag) String 

func (f *BigFlag) String() string

func (*BigFlag) TakesValue 

func (f *BigFlag) TakesValue() bool

type DirectoryFlag 

type DirectoryFlag struct {
	Name string

	Category    string
	DefaultText string
	Usage       string

	Required   bool
	Hidden     bool
	HasBeenSet bool

	Value DirectoryString

	Aliases []string
}

DirectoryFlag is custom cli.Flag type which expand the received string to an absolute path. e.g. ~/.ethereum -> /home/username/.ethereum

func (*DirectoryFlag) Apply 

func (f *DirectoryFlag) Apply(set *flag.FlagSet) error

Apply called by cli library, grabs variable from environment (if in env) and adds variable to flag set for parsing.

func (*DirectoryFlag) GetCategory 

func (f *DirectoryFlag) GetCategory() string

func (*DirectoryFlag) GetDefaultText 

func (f *DirectoryFlag) GetDefaultText() string

func (*DirectoryFlag) GetEnvVars 

func (f *DirectoryFlag) GetEnvVars() []string

func (*DirectoryFlag) GetUsage 

func (f *DirectoryFlag) GetUsage() string

func (*DirectoryFlag) GetValue 

func (f *DirectoryFlag) GetValue() string

func (*DirectoryFlag) IsRequired 

func (f *DirectoryFlag) IsRequired()