Control.Flipper.Types

Documentation

newtype Features

An abstraction representing the current state of the features store.

Constructors

Features

Fields

• unFeatures :: Map FeatureName Bool

Instances

Eq Features

Methods

(==) :: Features -> Features -> Bool

(/=) :: Features -> Features -> Bool

Show Features

Methods

showsPrec :: Int -> Features -> ShowS

show :: Features -> String

showList :: [Features] -> ShowS

Monoid Features

Methods

mempty :: Features

mappend :: Features -> Features -> Features

mconcat :: [Features] -> Features

Monad m => MonadState Features (FlipperT m)

Methods

get :: FlipperT m Features

put :: Features -> FlipperT m ()

state :: (Features -> (a, Features)) -> FlipperT m a

newtype FeatureName

The main identifier of a feature

Constructors

FeatureName

Fields

• unFeatureName :: Text

Instances

Eq FeatureName

Methods

(==) :: FeatureName -> FeatureName -> Bool

(/=) :: FeatureName -> FeatureName -> Bool

Ord FeatureName

Methods

compare :: FeatureName -> FeatureName -> Ordering

(<) :: FeatureName -> FeatureName -> Bool

(<=) :: FeatureName -> FeatureName -> Bool

(>) :: FeatureName -> FeatureName -> Bool

(>=) :: FeatureName -> FeatureName -> Bool

max :: FeatureName -> FeatureName -> FeatureName

min :: FeatureName -> FeatureName -> FeatureName

Show FeatureName

Methods

showsPrec :: Int -> FeatureName -> ShowS

show :: FeatureName -> String

showList :: [FeatureName] -> ShowS

IsString FeatureName

Methods

fromString :: String -> FeatureName

class Monad m => HasFeatureFlags m where

The HasFeatureFlags typeclass describes how to access the Features store within the current monad.

Methods

getFeatures :: m Features

getFeatures access the Features store within the current monad

getFeatures :: (MonadTrans t, HasFeatureFlags m1, m ~ t m1) => m Features

getFeatures access the Features store within the current monad

getFeature :: FeatureName -> m (Maybe Bool)

getFeature access a single Feature within the current monad

getFeature :: (MonadTrans t, HasFeatureFlags m1, m ~ t m1) => FeatureName -> m (Maybe Bool)

getFeature access a single Feature within the current monad

Instances

Monad m => HasFeatureFlags (FlipperT m)

Methods

getFeatures :: FlipperT m Features

getFeature :: FeatureName -> FlipperT m (Maybe Bool)

(MonadIO m, HasFeatureFlags m) => HasFeatureFlags (StateT s m)

Methods

getFeatures :: StateT s m Features

getFeature :: FeatureName -> StateT s m (Maybe Bool)

(MonadIO m, HasFeatureFlags m) => HasFeatureFlags (ReaderT * s m)

Methods

getFeatures :: ReaderT * s m Features

getFeature :: FeatureName -> ReaderT * s m (Maybe Bool)

class HasFeatureFlags m => ModifiesFeatureFlags m where

The ModifiesFeatureFlags typeclass describes how to modify the Features store within the current monad.

Methods

updateFeatures :: Features -> m ()

updateFeatures modifies the Features store within the current monad

updateFeatures :: (MonadTrans t, ModifiesFeatureFlags m1, m ~ t m1) => Features -> m ()

updateFeatures modifies the Features store within the current monad

updateFeature :: FeatureName -> Bool -> m ()

updateFeature modifies a single Feature within the current monad

updateFeature :: (MonadTrans t, ModifiesFeatureFlags m1, m ~ t m1) => FeatureName -> Bool -> m ()

updateFeature modifies a single Feature within the current monad

Instances

Monad m => ModifiesFeatureFlags (FlipperT m)

Methods

updateFeatures :: Features -> FlipperT m ()

updateFeature :: FeatureName -> Bool -> FlipperT m ()

(MonadIO m, ModifiesFeatureFlags m) => ModifiesFeatureFlags (StateT s m)

Methods

updateFeatures :: Features -> StateT s m ()

updateFeature :: FeatureName -> Bool -> StateT s m ()

(MonadIO m, ModifiesFeatureFlags m) => ModifiesFeatureFlags (ReaderT * s m)

Methods

updateFeatures :: Features -> ReaderT * s m ()

updateFeature :: FeatureName -> Bool -> ReaderT * s m ()

update :: ModifiesFeatureFlags m => FeatureName -> (Maybe Bool -> Maybe Bool) -> m ()

Updates a single Feature within the current monad

mkFeatures :: Map FeatureName Bool -> Features

Convienience constructor