Safe Haskell	None
Language	Haskell2010

RichEnv.Types

Contents

Description

This module contains the basic types used by the library and their typeclass instances.

Synopsis

data RichEnv = RichEnv {
- values :: Values
- mappings :: Mappings
- prefixes :: Prefixes
}
defaultRichEnv :: RichEnv
type Environment = [(Text, Text)]
newtype Mappings = Mappings {
- unMappings :: HashMap Text Text
}
newtype Values = Values {
- unValues :: HashMap Text Text
}
newtype Prefixes = Prefixes {
- unPrefixes :: HashMap Text [Text]
}
toEnvironment :: [(String, String)] -> Environment
fromEnvironment :: Environment -> [(String, String)]

Types

data RichEnv Source #

Type that represents a set of rules that generate environment variables. A value of this type can be retrieved from a configuration file (e.g. YAML) due to its FromJSON instance, or persisted into one with ToJSON.

Constructors

RichEnv
Fields values :: Values A list of environment variables to be set with their values. mappings :: Mappings Mappings from one existing environment variable name to another. prefixes :: Prefixes Mappings from different prefixes of existing environment variables to new prefixes.

Instances

Instances details

FromJSON RichEnv Source #

Instance details

Defined in RichEnv.Types

Methods

parseJSON :: Value -> Parser RichEnv #

parseJSONList :: Value -> Parser [RichEnv] #

omittedField :: Maybe RichEnv #

ToJSON RichEnv Source #

Instance details

Defined in RichEnv.Types

Methods

toJSON :: RichEnv -> Value #

toEncoding :: RichEnv -> Encoding #

toJSONList :: [RichEnv] -> Value #

toEncodingList :: [RichEnv] -> Encoding #

omitField :: RichEnv -> Bool #

Monoid RichEnv Source #

Instance details

Defined in RichEnv.Types

Methods

mempty :: RichEnv #

mappend :: RichEnv -> RichEnv -> RichEnv #

mconcat :: [RichEnv] -> RichEnv #

Semigroup RichEnv Source #

Instance details

Defined in RichEnv.Types

Methods

(<>) :: RichEnv -> RichEnv -> RichEnv #

sconcat :: NonEmpty RichEnv -> RichEnv #

stimes :: Integral b => b -> RichEnv -> RichEnv #

Generic RichEnv Source #

Instance details

Defined in RichEnv.Types

Associated Types

type Rep RichEnv

Instance details

Defined in RichEnv.Types

type Rep RichEnv = D1 ('MetaData "RichEnv" "RichEnv.Types" "richenv-0.1.0.3-ACzqnYxtH2bDZMTb2tXeLY" 'False) (C1 ('MetaCons "RichEnv" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Values) :*: (S1 ('MetaSel ('Just "mappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mappings) :*: S1 ('MetaSel ('Just "prefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Prefixes))))

Methods

from :: RichEnv -> Rep RichEnv x #

to :: Rep RichEnv x -> RichEnv #

Show RichEnv Source #

Instance details

Defined in RichEnv.Types

Methods

showsPrec :: Int -> RichEnv -> ShowS #

show :: RichEnv -> String #

showList :: [RichEnv] -> ShowS #

Eq RichEnv Source #

Instance details

Defined in RichEnv.Types

Methods

(==) :: RichEnv -> RichEnv -> Bool #

(/=) :: RichEnv -> RichEnv -> Bool #

type Rep RichEnv Source #

Instance details

Defined in RichEnv.Types

type Rep RichEnv = D1 ('MetaData "RichEnv" "RichEnv.Types" "richenv-0.1.0.3-ACzqnYxtH2bDZMTb2tXeLY" 'False) (C1 ('MetaCons "RichEnv" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Values) :*: (S1 ('MetaSel ('Just "mappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mappings) :*: S1 ('MetaSel ('Just "prefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Prefixes))))

defaultRichEnv :: RichEnv Source #

Default RichEnv value. With everything empty.

type Environment = [(Text, Text)] Source #

A list of key-value pairs representing environment variables.

newtype Mappings Source #

A list of key-value pairs representing environment variable name mappings. The internal representation is a 'HashMap Text Text', where the key is the final variable name and the value is the current one which will be replaced.

Constructors

Mappings
Fields unMappings :: HashMap Text Text

Instances

Instances details

FromJSON Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

Methods

parseJSON :: Value -> Parser Mappings #

parseJSONList :: Value -> Parser [Mappings] #

omittedField :: Maybe Mappings #

ToJSON Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

Methods

toJSON :: Mappings -> Value #

toEncoding :: Mappings -> Encoding #

toJSONList :: [Mappings] -> Value #

toEncodingList :: [Mappings] -> Encoding #

omitField :: Mappings -> Bool #

Monoid Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

Methods

mempty :: Mappings #

mappend :: Mappings -> Mappings -> Mappings #

mconcat :: [Mappings] -> Mappings #

Semigroup Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

Methods

(<>) :: Mappings -> Mappings -> Mappings #

sconcat :: NonEmpty Mappings -> Mappings #

stimes :: Integral b => b -> Mappings -> Mappings #

Generic Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

Associated Types

type Rep Mappings
Instance details Defined in RichEnv.Types.Mappings type Rep Mappings = D1 ('MetaData "Mappings" "RichEnv.Types.Mappings" "richenv-0.1.0.3-ACzqnYxtH2bDZMTb2tXeLY" 'True) (C1 ('MetaCons "Mappings" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text Text))))

Methods

from :: Mappings -> Rep Mappings x #

to :: Rep Mappings x -> Mappings #

Show Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

Methods

showsPrec :: Int -> Mappings -> ShowS #

show :: Mappings -> String #

showList :: [Mappings] -> ShowS #

Eq Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

Methods

(==) :: Mappings -> Mappings -> Bool #

(/=) :: Mappings -> Mappings -> Bool #

type Rep Mappings Source #

Instance details

Defined in RichEnv.Types.Mappings

type Rep Mappings = D1 ('MetaData "Mappings" "RichEnv.Types.Mappings" "richenv-0.1.0.3-ACzqnYxtH2bDZMTb2tXeLY" 'True) (C1 ('MetaCons "Mappings" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text Text))))

newtype Values Source #

A list of key-value pairs representing environment variables. The internal representation is a 'HashMap Text Text', where the key is the variable name and the value is the variable value.

Constructors

Values
Fields unValues :: HashMap Text Text

Instances

Instances details

FromJSON Values Source #

Instance details

Defined in RichEnv.Types.Values

Methods

parseJSON :: Value -> Parser Values #

parseJSONList :: Value -> Parser [Values] #

omittedField :: Maybe Values #

ToJSON Values Source #

Instance details

Defined in RichEnv.Types.Values

Methods

toJSON :: Values -> Value #

toEncoding :: Values -> Encoding #

toJSONList :: [Values] -> Value #

toEncodingList :: [Values] -> Encoding #

omitField :: Values -> Bool #

Monoid Values Source #

Instance details

Defined in RichEnv.Types.Values

Methods

mempty :: Values #

mappend :: Values -> Values -> Values #

mconcat :: [Values] -> Values #

Semigroup Values Source #

Instance details

Defined in RichEnv.Types.Values

Methods

(<>) :: Values -> Values -> Values #

sconcat :: NonEmpty Values -> Values #

stimes :: Integral b => b -> Values -> Values #

Generic Values Source #

Instance details

Defined in RichEnv.Types.Values

Associated Types

type Rep Values
Instance details Defined in RichEnv.Types.Values type Rep Values = D1 ('MetaData "Values" "RichEnv.Types.Values" "richenv-0.1.0.3-ACzqnYxtH2bDZMTb2tXeLY" 'True) (C1 ('MetaCons "Values" 'PrefixI 'True) (S1 ('MetaSel ('Just "unValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text Text))))

Methods

from :: Values -> Rep Values x #

to :: Rep Values x -> Values #

Show Values Source #

Instance details

Defined in RichEnv.Types.Values

Methods

showsPrec :: Int -> Values -> ShowS #

show :: Values -> String #

showList :: [Values] -> ShowS #

Eq Values Source #

Instance details

Defined in RichEnv.Types.Values

Methods

(==) :: Values -> Values -> Bool #

(/=) :: Values -> Values -> Bool #

type Rep Values Source #

Instance details

Defined in RichEnv.Types.Values

type Rep Values = D1 ('MetaData "Values" "RichEnv.Types.Values" "richenv-0.1.0.3-ACzqnYxtH2bDZMTb2tXeLY" 'True) (C1 ('MetaCons "Values" 'PrefixI 'True) (S1 ('MetaSel ('Just "unValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text Text))))

newtype Prefixes Source #

A list of key-value pairs representing environment variable name prefix mappings. The internal representation is a 'HashMap Text [Text]', where the key is the final prefix and the value is the list of prefixes that will be replaced.

Constructors

Prefixes
Fields unPrefixes :: HashMap Text [Text]

Instances

Instances details

FromJSON Prefixes Source #

Instance details

Defined in RichEnv.Types.Prefixes

Methods

parseJSON :: Value -> Parser Prefixes #

parseJSONList :: Value -> Parser [Prefixes] #

omittedField :: Maybe Prefixes #

ToJSON Prefixes Source #

Instance details

Defined in RichEnv.Types.Prefixes

Methods

toJSON :: Prefixes -> Value #

toEncoding :: Prefixes -> Encoding #

toJSONList :: [Prefixes] -> Value #

toEncodingList :: [Prefixes] -> Encoding #

omitField :: Prefixes -> Bool #

Monoid Prefixes Source #

Instance details

Defined in RichEnv.Types.Prefixes

Methods

mempty :: Prefixes #

mappend :: Prefixes -> Prefixes -> Prefixes #

mconcat :: [Prefixes] -> Prefixes #

Semigroup Prefixes Source #

Instance details

Defined in RichEnv.Types.Prefixes

Methods

(<>) :: Prefixes -> Prefixes -> Prefixes #

sconcat :: NonEmpty Prefixes -> Prefixes #

stimes :: Integral b => b -> Prefixes -> Prefixes #

Generic Prefixes Source #

Instance details

Defined in RichEnv.Types.Prefixes

Associated Types

type Rep Prefixes
Instance details Defined in RichEnv.Types.Prefixes type Rep Prefixes = D1 ('MetaData "Prefixes" "RichEnv.Types.Prefixes" "richenv-0.1.0.3-ACzqnYxtH2bDZMTb2tXeLY" 'True) (C1 ('MetaCons "Prefixes" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPrefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text [Text]))))