model

Documentation

Index

• func Hash(s string) uint32
• type DiffCache
  • func (d DiffCache) HasDiff() bool
• type DiffUpdated
• type Flag
  • func (f Flag) String() string
  • func (f *Flag) Value(flagName string, user ffuser.User) (interface{}, VariationType)
• type VariationType

Functions

func Hash

func Hash(s string) uint32

Hash is taking a string and convert.

Types

type DiffCache

type DiffCache struct {
	Deleted map[string]Flag        `json:"deleted"`
	Added   map[string]Flag        `json:"added"`
	Updated map[string]DiffUpdated `json:"updated"`
}

DiffCache contains the changes made in the cache, to be able to notify the user that something has changed (logs, webhook ...)

func (DiffCache) HasDiff

func (d DiffCache) HasDiff() bool

HasDiff check if we have differences

type DiffUpdated

type DiffUpdated struct {
	Before Flag `json:"old_value"`
	After  Flag `json:"new_value"`
}

type Flag

type Flag struct {
	Disable    bool        `json:"disable,omitempty"`
	Rule       string      `json:"rule,omitempty"`
	Percentage float64     `json:"percentage,omitempty"`
	True       interface{} `json:"true,omitempty"`    // Value if Rule applied, and in percentage
	False      interface{} `json:"false,omitempty"`   // Value if Rule applied and not in percentage
	Default    interface{} `json:"default,omitempty"` // Value if Rule does not applied
}

Flag describe the fields of a flag.

func (Flag) String

func (f Flag) String() string

string display correctly a flag

func (*Flag) Value

func (f *Flag) Value(flagName string, user ffuser.User) (interface{}, VariationType)

Value is returning the Value associate to the flag (True / False / Default ) based if the toggle apply to the user or not.

type VariationType

type VariationType string

VariationType enum which describe the decision taken

const (
	VariationTrue       VariationType = "True"
	VariationFalse      VariationType = "False"
	VariationDefault    VariationType = "Default"
	VariationSDKDefault VariationType = "SdkDefault"
)