flags

package

v0.0.0-...-6d11654 Latest Latest Go to latest Published: Apr 22, 2023 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/euforic/backend-base

Links

Open Source Insights

Documentation ¶

Index ¶

func FlagToEnv(prefix, name string) string
func IsPSet(fs *pflag.FlagSet, name string) bool
func IsSet(fs *flag.FlagSet, name string) bool
func SetFlagsFromEnv(prefix string, fs *flag.FlagSet) error
func SetPflagsFromEnv(prefix string, fs *pflag.FlagSet) error
type DeprecatedFlag
- func (f *DeprecatedFlag) Set(_ string) error
- func (f *DeprecatedFlag) String() string
type IgnoredFlag

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FlagToEnv ¶

func FlagToEnv(prefix, name string) string

FlagToEnv converts flag string to upper-case environment variable key string.

func IsPSet ¶

func IsPSet(fs *pflag.FlagSet, name string) bool

IsPSet checks if flagset has set but with pflag

func SetFlagsFromEnv ¶

func SetFlagsFromEnv(prefix string, fs *flag.FlagSet) error

SetFlagsFromEnv parses all registered flags in the given flagset, and if they are not already set it attempts to set their values from environment variables. Environment variables take the name of the flag but are UPPERCASE, have the given prefix and any dashes are replaced by underscores - for example: some-flag => PREFIX_SOME_FLAG

func SetPflagsFromEnv ¶

func SetPflagsFromEnv(prefix string, fs *pflag.FlagSet) error

SetPflagsFromEnv is similar to SetFlagsFromEnv. However, the accepted flagset type is pflag.FlagSet and it does not do any logging.

Types ¶

type DeprecatedFlag ¶

type DeprecatedFlag struct {
	Name string
}

DeprecatedFlag encapsulates a flag that may have been previously valid but is now deprecated. If a DeprecatedFlag is set, an error occurs.

func (*DeprecatedFlag) Set ¶

func (f *DeprecatedFlag) Set(_ string) error

Set returns an error

func (*DeprecatedFlag) String ¶

func (f *DeprecatedFlag) String() string

String ...

type IgnoredFlag ¶

type IgnoredFlag struct {
	Name string
}

IgnoredFlag encapsulates a flag that may have been previously valid but is now ignored. If an IgnoredFlag is set, a warning is printed and operation continues.

func (*IgnoredFlag) IsBoolFlag ¶

func (f *IgnoredFlag) IsBoolFlag() bool

IsBoolFlag is defined to allow the flag to be defined without an argument

func (*IgnoredFlag) Set ¶

func (f *IgnoredFlag) Set(s string) error

Set is not supported anymore

func (*IgnoredFlag) String ¶

func (f *IgnoredFlag) String() string