feature

Documentation

Index

• Constants
• func NewFeatureGate() *featureGate
• type Feature
• type FeatureGate
• type FeatureSpec

Constants

const (
	// Values for PreRelease.
	Alpha = prerelease("ALPHA")
	Beta  = prerelease("BETA")
	GA    = prerelease("")
)

Functions

func NewFeatureGate

func NewFeatureGate() *featureGate

Types

type Feature

type Feature string

type FeatureGate

type FeatureGate interface {
	// AddFlag adds a flag for setting global feature gates to the specified FlagSet.
	AddFlag(fs *pflag.FlagSet)
	// Set parses and stores flag gates for known features
	// from a string like feature1=true,feature2=false,...
	Set(value string) error
	// SetFromMap stores flag gates for known features from a map[string]bool or returns an error
	SetFromMap(m map[string]bool) error
	// Enabled returns true if the key is enabled.
	Enabled(key Feature) bool
	// Add adds features to the featureGate.
	Add(features map[Feature]FeatureSpec) error
	// KnownFeatures returns a slice of strings describing the FeatureGate's known features.
	KnownFeatures() []string
}

FeatureGate parses and stores flag gates for known features from a string like feature1=true,feature2=false,...

var (

	// DefaultFeatureGate is a shared global FeatureGate.
	DefaultFeatureGate FeatureGate = NewFeatureGate()
)

type FeatureSpec

type FeatureSpec struct {
	Default    bool
	PreRelease prerelease
}