Salak.Internal

This module is used for implementing loaders.

Documentation

loadAndRunSalak' :: (MonadThrow m, MonadIO m) => LoadSalakT m () -> (SourcePack -> m a) -> m a

Standard salak functions, by load and with a SourcePack instance. Users should use SourcePack to create custom MonadSalak instances, then you get will an instance of MonadSalak.

loadTrie :: (MonadThrow m, MonadIO m) => Bool -> String -> (Int -> IO TraceSource) -> LoadSalakT m ()

Basic loader

loadList :: (MonadThrow m, MonadIO m, Foldable f, ToKeys k, ToValue v) => Bool -> String -> IO (f (k, v)) -> LoadSalakT m ()

Simple loader

data LoadSalakT m a

Configuration Loader Monad, used for load properties from sources. Custom loaders using loadTrie

Instances

MonadTrans LoadSalakT

Defined in Salak.Internal

Methods

lift :: Monad m => m a -> LoadSalakT m a

Monad m => Monad (LoadSalakT m)

Defined in Salak.Internal

Methods

(>>=) :: LoadSalakT m a -> (a -> LoadSalakT m b) -> LoadSalakT m b

(>>) :: LoadSalakT m a -> LoadSalakT m b -> LoadSalakT m b

return :: a -> LoadSalakT m a

fail :: String -> LoadSalakT m a

Functor m => Functor (LoadSalakT m)

Defined in Salak.Internal

Methods

fmap :: (a -> b) -> LoadSalakT m a -> LoadSalakT m b

(<$) :: a -> LoadSalakT m b -> LoadSalakT m a

Monad m => Applicative (LoadSalakT m)

Defined in Salak.Internal

Methods

pure :: a -> LoadSalakT m a

(<*>) :: LoadSalakT m (a -> b) -> LoadSalakT m a -> LoadSalakT m b

liftA2 :: (a -> b -> c) -> LoadSalakT m a -> LoadSalakT m b -> LoadSalakT m c

(*>) :: LoadSalakT m a -> LoadSalakT m b -> LoadSalakT m b

(<*) :: LoadSalakT m a -> LoadSalakT m b -> LoadSalakT m a

MonadIO m => MonadIO (LoadSalakT m)

Defined in Salak.Internal

Methods

liftIO :: IO a -> LoadSalakT m a

MonadThrow m => MonadThrow (LoadSalakT m)

Defined in Salak.Internal

Methods

throwM :: Exception e => e -> LoadSalakT m a

MonadCatch m => MonadCatch (LoadSalakT m)

Defined in Salak.Internal

Methods

catch :: Exception e => LoadSalakT m a -> (e -> LoadSalakT m a) -> LoadSalakT m a

(MonadThrow m, MonadUnliftIO m) => MonadUnliftIO (LoadSalakT m)

Defined in Salak.Internal

Methods

askUnliftIO :: LoadSalakT m (UnliftIO (LoadSalakT m))

withRunInIO :: ((forall a. LoadSalakT m a -> IO a) -> IO b) -> LoadSalakT m b

MonadIO m => MonadSalak (LoadSalakT m)

Defined in Salak.Internal

Methods

askSourcePack :: LoadSalakT m SourcePack

askReload :: LoadSalakT m (IO ReloadResult)

setLogF :: (String -> IO ()) -> LoadSalakT m ()

logSalak :: String -> LoadSalakT m ()

require :: (MonadThrow (LoadSalakT m), FromProp (LoadSalakT m) a) => Text -> LoadSalakT m a

type LoadSalak = LoadSalakT IO

Simple IO Monad

data RunSalakT m a

Standard MonadSalak instance.

Instances

MonadTrans RunSalakT

Defined in Salak.Internal

Methods

lift :: Monad m => m a -> RunSalakT m a

Monad m => MonadReader SourcePack (RunSalakT m)

Defined in Salak.Internal

Methods

ask :: RunSalakT m SourcePack

local :: (SourcePack -> SourcePack) -> RunSalakT m a -> RunSalakT m a

reader :: (SourcePack -> a) -> RunSalakT m a

Monad m => Monad (RunSalakT m)

Defined in Salak.Internal

Methods

(>>=) :: RunSalakT m a -> (a -> RunSalakT m b) -> RunSalakT m b

(>>) :: RunSalakT m a -> RunSalakT m b -> RunSalakT m b

return :: a -> RunSalakT m a

fail :: String -> RunSalakT m a

Functor m => Functor (RunSalakT m)

Defined in Salak.Internal

Methods

fmap :: (a -> b) -> RunSalakT m a -> RunSalakT m b

(<$) :: a -> RunSalakT m b -> RunSalakT m a

Applicative m => Applicative (RunSalakT m)

Defined in Salak.Internal

Methods

pure :: a -> RunSalakT m a

(<*>) :: RunSalakT m (a -> b) -> RunSalakT m a -> RunSalakT m b

liftA2 :: (a -> b -> c) -> RunSalakT m a -> RunSalakT m b -> RunSalakT m c

(*>) :: RunSalakT m a -> RunSalakT m b -> RunSalakT m b

(<*) :: RunSalakT m a -> RunSalakT m b -> RunSalakT m a

MonadIO m => MonadIO (RunSalakT m)

Defined in Salak.Internal

Methods

liftIO :: IO a -> RunSalakT m a

MonadThrow m => MonadThrow (RunSalakT m)

Defined in Salak.Internal

Methods

throwM :: Exception e => e -> RunSalakT m a

MonadCatch m => MonadCatch (RunSalakT m)

Defined in Salak.Internal

Methods

catch :: Exception e => RunSalakT m a -> (e -> RunSalakT m a) -> RunSalakT m a

(MonadThrow m, MonadUnliftIO m) => MonadUnliftIO (RunSalakT m)

Defined in Salak.Internal

Methods

askUnliftIO :: RunSalakT m (UnliftIO (RunSalakT m))

withRunInIO :: ((forall a. RunSalakT m a -> IO a) -> IO b) -> RunSalakT m b

MonadIO m => MonadSalak (RunSalakT m)

Defined in Salak.Internal

Methods

askSourcePack :: RunSalakT m SourcePack

askReload :: RunSalakT m (IO ReloadResult)

setLogF :: (String -> IO ()) -> RunSalakT m ()

logSalak :: String -> RunSalakT m ()

require :: (MonadThrow (RunSalakT m), FromProp (RunSalakT m) a) => Text -> RunSalakT m a

type RunSalak = RunSalakT IO

Simple IO Monad

runRun :: Monad m => RunSalakT m a -> SourcePack -> m a

class Monad m => MonadSalak m where

Core type class of salak, which provide function to parse properties.

Minimal complete definition

askSourcePack

Methods

askSourcePack :: m SourcePack

Monad has the ability to get a SourcePack instance.

askReload :: m (IO ReloadResult)

Get reload action which used for reload profiles

setLogF :: MonadIO m => (String -> IO ()) -> m ()

logSalak :: MonadIO m => String -> m ()

require :: (MonadThrow m, FromProp m a) => Text -> m a

Parse properties using FromProp. For example:

a :: Bool              <- require "bool.key"
b :: Maybe Int         <- require "int.optional.key"
c :: Either String Int <- require "int.error.key"
d :: IO Int            <- require "int.reloadable.key"

require supports parse IO values, which actually wrap a MVar variable and can be reseted by reloading configurations. Normal value will not be affected by reloading configurations.

Instances

MonadIO m => MonadSalak (RunSalakT m)

Defined in Salak.Internal

Methods

askSourcePack :: RunSalakT m SourcePack

askReload :: RunSalakT m (IO ReloadResult)

setLogF :: (String -> IO ()) -> RunSalakT m ()

logSalak :: String -> RunSalakT m ()

require :: (MonadThrow (RunSalakT m), FromProp (RunSalakT m) a) => Text -> RunSalakT m a

MonadIO m => MonadSalak (LoadSalakT m)

Defined in Salak.Internal

Methods

askSourcePack :: LoadSalakT m SourcePack

askReload :: LoadSalakT m (IO ReloadResult)

setLogF :: (String -> IO ()) -> LoadSalakT m ()

logSalak :: String -> LoadSalakT m ()

require :: (MonadThrow (LoadSalakT m), FromProp (LoadSalakT m) a) => Text -> LoadSalakT m a

loadMock :: (MonadThrow m, MonadIO m) => [(Text, Text)] -> LoadSalakT m ()

Load mock variables into Source

loadEnv :: (MonadThrow m, MonadIO m) => LoadSalakT m ()

Load environment variables into Source

loadCommandLine :: (MonadThrow m, MonadIO m) => ParseCommandLine -> LoadSalakT m ()

Default way to parse command line arguments

type ParseCommandLine = [String] -> IO [(Text, Text)]

Convert arguments to properties

defaultParseCommandLine :: ParseCommandLine

Default way to parse command line arguments

tryLoadFile :: MonadIO m => (FilePath -> LoadSalakT m ()) -> FilePath -> LoadSalakT m ()

Try load file, if file does not exist then do nothing.

type Source = Trie Vals

type TraceSource = Trie ([String], Vals)

newtype Keys

Constructors

Keys

Fields

• unKeys :: DList Key

Instances

Eq Keys

Defined in Salak.Internal.Key

Methods

(==) :: Keys -> Keys -> Bool

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

Show Keys

Defined in Salak.Internal.Key

Methods

showsPrec :: Int -> Keys -> ShowS

show :: Keys -> String

showList :: [Keys] -> ShowS

Semigroup Keys

Defined in Salak.Internal.Key

Methods

(<>) :: Keys -> Keys -> Keys

sconcat :: NonEmpty Keys -> Keys

stimes :: Integral b => b -> Keys -> Keys

Monoid Keys

Defined in Salak.Internal.Key

Methods

mempty :: Keys

mappend :: Keys -> Keys -> Keys

mconcat :: [Keys] -> Keys

ToKeys Keys

Defined in Salak.Internal.Key

Methods

toKeys :: Keys -> Either String Keys

data Key

Constructors

KT !Text

KI !Int

Instances

Eq Key

Defined in Salak.Internal.Key

Methods

(==) :: Key -> Key -> Bool

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

Ord Key

Defined in Salak.Internal.Key

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

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

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Defined in Salak.Internal.Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Hashable Key

Defined in Salak.Internal.Key

Methods

hashWithSalt :: Int -> Key -> Int

hash :: Key -> Int

simpleKeys :: Text -> Keys

fromKeys :: [Key] -> Keys

class ToKeys a where

Methods

toKeys :: a -> Either String Keys

Instances

ToKeys Text

Defined in Salak.Internal.Key

Methods

toKeys :: Text -> Either String Keys

ToKeys String

Defined in Salak.Internal.Key

Methods

toKeys :: String -> Either String Keys

ToKeys Keys

Defined in Salak.Internal.Key

Methods

toKeys :: Keys -> Either String Keys

setVal :: ToValue v => Int -> v -> TraceSource -> TraceSource

data Val v

Constructors

Val !Int !v

Instances

Eq v => Eq (Val v)

Defined in Salak.Internal.Val

Methods

(==) :: Val v -> Val v -> Bool

(/=) :: Val v -> Val v -> Bool

Eq v => Ord (Val v)

Defined in Salak.Internal.Val

Methods

compare :: Val v -> Val v -> Ordering

(<) :: Val v -> Val v -> Bool

(<=) :: Val v -> Val v -> Bool

(>) :: Val v -> Val v -> Bool

(>=) :: Val v -> Val v -> Bool

max :: Val v -> Val v -> Val v

min :: Val v -> Val v -> Val v

Show v => Show (Val v)

Defined in Salak.Internal.Val

Methods

showsPrec :: Int -> Val v -> ShowS

show :: Val v -> String

showList :: [Val v] -> ShowS

data Value

Constructors

VT !Text

VI !Scientific

VB !Bool

VLT !LocalTime

VD !Day

VH !TimeOfDay

VZT !TimeZone !LocalTime

VU !UTCTime

Instances

Eq Value

Defined in Salak.Internal.Val

Methods

(==) :: Value -> Value -> Bool

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

Show Value

Defined in Salak.Internal.Val

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

ToValue Value

Defined in Salak.Internal.Val

Methods

toVal :: Value -> Value

class ToValue a where

Methods

toVal :: a -> Value

Instances

ToValue Bool

Defined in Salak.Internal.Val

Methods

toVal :: Bool -> Value

ToValue Double

Defined in Salak.Internal.Val

Methods

toVal :: Double -> Value

ToValue Int

Defined in Salak.Internal.Val

Methods

toVal :: Int -> Value

ToValue Int64

Defined in Salak.Internal.Val

Methods

toVal :: Int64 -> Value

ToValue Integer

Defined in Salak.Internal.Val

Methods

toVal :: Integer -> Value

ToValue ByteString

Defined in Salak.Internal.Val

Methods

toVal :: ByteString -> Value

ToValue Text

Defined in Salak.Internal.Val

Methods

toVal :: Text -> Value

ToValue String

Defined in Salak.Internal.Val

Methods

toVal :: String -> Value

ToValue Scientific

Defined in Salak.Internal.Val

Methods

toVal :: Scientific -> Value

ToValue UTCTime

Defined in Salak.Internal.Val

Methods

toVal :: UTCTime -> Value

ToValue Value

Defined in Salak.Internal.Val

Methods

toVal :: Value -> Value

liftNT :: MonadIO m => LoadSalak () -> LoadSalakT m ()

data SourcePack

Constructors

SourcePack

Fields

• source :: !Source
• pref :: !Keys
• qref :: !(MVar QFunc)
• lref :: !(MVar LFunc)
• reload :: !(IO ReloadResult)

Instances

Monad m => MonadReader SourcePack (Prop m)

Defined in Salak.Internal.Prop

Methods

ask :: Prop m SourcePack

local :: (SourcePack -> SourcePack) -> Prop m a -> Prop m a

reader :: (SourcePack -> a) -> Prop m a

Monad m => MonadReader SourcePack (RunSalakT m)

Defined in Salak.Internal

Methods

ask :: RunSalakT m SourcePack

local :: (SourcePack -> SourcePack) -> RunSalakT m a -> RunSalakT m a

reader :: (SourcePack -> a) -> RunSalakT m a

class Monad m => MonadIO (m :: Type -> Type)

Monads in which IO computations may be embedded. Any monad built by applying a sequence of monad transformers to the IO monad will be an instance of this class.

Instances should satisfy the following laws, which state that liftIO is a transformer of monads:

• liftIO . return = return

• liftIO (m >>= f) = liftIO m >>= (liftIO . f)

Minimal complete definition

liftIO

Instances

MonadIO IO

Since: base-4.9.0.0

Defined in Control.Monad.IO.Class

Methods

liftIO :: IO a -> IO a

MonadIO Q

Defined in Language.Haskell.TH.Syntax

Methods

liftIO :: IO a -> Q a

MonadIO m => MonadIO (MaybeT m)

Defined in Control.Monad.Trans.Maybe

Methods

liftIO :: IO a -> MaybeT m a

MonadIO m => MonadIO (ListT m)

Defined in Control.Monad.Trans.List

Methods

liftIO :: IO a -> ListT m a

MonadIO m => MonadIO (Prop m)

Defined in Salak.Internal.Prop

Methods

liftIO :: IO a -> Prop m a

MonadIO m => MonadIO (RunSalakT m)

Defined in Salak.Internal

Methods

liftIO :: IO a -> RunSalakT m a

MonadIO m => MonadIO (LoadSalakT m)

Defined in Salak.Internal

Methods

liftIO :: IO a -> LoadSalakT m a

MonadIO m => MonadIO (ExceptT e m)

Defined in Control.Monad.Trans.Except

Methods

liftIO :: IO a -> ExceptT e m a

MonadIO m => MonadIO (IdentityT m)

Defined in Control.Monad.Trans.Identity

Methods

liftIO :: IO a -> IdentityT m a

(Error e, MonadIO m) => MonadIO (ErrorT e m)

Defined in Control.Monad.Trans.Error

Methods

liftIO :: IO a -> ErrorT e m a

MonadIO m => MonadIO (StateT s m)

Defined in Control.Monad.Trans.State.Lazy

Methods

liftIO :: IO a -> StateT s m a

MonadIO m => MonadIO (StateT s m)

Defined in Control.Monad.Trans.State.Strict

Methods

liftIO :: IO a -> StateT s m a

(Monoid w, MonadIO m) => MonadIO (WriterT w m)

Defined in Control.Monad.Trans.Writer.Lazy

Methods

liftIO :: IO a -> WriterT w m a

(Monoid w, MonadIO m) => MonadIO (WriterT w m)

Defined in Control.Monad.Trans.Writer.Strict

Methods

liftIO :: IO a -> WriterT w m a

MonadIO m => MonadIO (ContT r m)

Defined in Control.Monad.Trans.Cont

Methods

liftIO :: IO a -> ContT r m a

MonadIO m => MonadIO (ReaderT r m)

Defined in Control.Monad.Trans.Reader

Methods

liftIO :: IO a -> ReaderT r m a

(Monoid w, MonadIO m) => MonadIO (RWST r w s m)

Defined in Control.Monad.Trans.RWS.Lazy

Methods

liftIO :: IO a -> RWST r w s m a

(Monoid w, MonadIO m) => MonadIO (RWST r w s m)

Defined in Control.Monad.Trans.RWS.Strict

Methods

liftIO :: IO a -> RWST r w s m a

Writable Value

data Writable a

Writable data structure. Writable is designed for working with IO value pased by salak. It provide a way to override IO value provided by salak, can be used in the application which need to change values of some configurations by overriding it directly. For example, logger function can use a log level property to control which level of logs should be printed. By using Writeable value, we can change the property directly.

toWritable :: IO a -> IO (Writable a)

Convert a IO value to Writable value.

getWritable :: Writable a -> IO a

Get value.

setWritable :: Maybe a -> Writable a -> IO ()

Set or remove override value.