flagger

Documentation

Index

• Constants
• Variables
• type Flag
  • func (f *Flag) MarshalBinary() ([]byte, error)
  • func (f *Flag) UnmarshalBinary(data []byte) error
  • func (f *Flag) Value() bool
• type Flagger
  • func NewRedisFlagger(host string, db int) (Flagger, error)
• type RedisFlagger
  • func (rf *RedisFlagger) GetFlag(name string) (*Flag, error)
  • func (rf *RedisFlagger) GetFlagWithTags(name string, tags []string) (*Flag, error)
  • func (rf *RedisFlagger) ListFlags() (flags []*Flag, err error)
  • func (rf *RedisFlagger) SaveFlag(flag *Flag) error

Constants

const (
	BOOL    flagType = "BOOL"    // BOOL is a simple boolean flag type
	PERCENT flagType = "PERCENT" // PERCENT is a boolean that is true ${PERCENT}% of the time
)

flagTypes are types of flags

Variables

var ErrFlagNotFound = errors.New("Flag not found")

ErrFlagNotFound means the flag was not found

Types

type Flag

type Flag struct {
	Name          string
	Type          flagType `json:"type"`
	InternalValue int      `json:"value"`
	Namespace     string   `json:"namespace"`
	Tags          []string `json:"tags"`
}

Flag is a flag ;)

func (*Flag) MarshalBinary

func (f *Flag) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding support for redis

func (*Flag) UnmarshalBinary

func (f *Flag) UnmarshalBinary(data []byte) error

UnmarshalBinary implements encoding support for redis

func (*Flag) Value

func (f *Flag) Value() bool

Value returns the calculated flag value

type Flagger

type Flagger interface {
	SaveFlag(flag *Flag) error
	GetFlag(name string) (*Flag, error)
	GetFlagWithTags(name string, tags []string) (*Flag, error)
	ListFlags() ([]*Flag, error)
}

Flagger is implemented by each of the storage backends

func NewRedisFlagger

func NewRedisFlagger(host string, db int) (Flagger, error)

NewRedisFlagger creates a new flagger backed by redis

type RedisFlagger

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

RedisFlagger is a redis backed flagger

func (*RedisFlagger) GetFlag

func (rf *RedisFlagger) GetFlag(name string) (*Flag, error)

GetFlag loads a flag without tags

func (*RedisFlagger) GetFlagWithTags

func (rf *RedisFlagger) GetFlagWithTags(name string, tags []string) (*Flag, error)

GetFlagWithTags loads a flag from a redis client

func (*RedisFlagger) ListFlags

func (rf *RedisFlagger) ListFlags() (flags []*Flag, err error)

ListFlags returns a list of flags grouped by name and environment

func (*RedisFlagger) SaveFlag

func (rf *RedisFlagger) SaveFlag(flag *Flag) error

SaveFlag saves a flag to redis