Data.Interpolation

Documentation

newtype TemplateKey

Newtype wrapper for an environment variable key.

Constructors

TemplateKey

Fields

• unTemplateKey :: Text

Instances

Eq TemplateKey

Defined in Data.Interpolation

Methods

(==) :: TemplateKey -> TemplateKey -> Bool

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

Ord TemplateKey

Defined in Data.Interpolation

Methods

compare :: TemplateKey -> TemplateKey -> Ordering

(<) :: TemplateKey -> TemplateKey -> Bool

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

(>) :: TemplateKey -> TemplateKey -> Bool

(>=) :: TemplateKey -> TemplateKey -> Bool

max :: TemplateKey -> TemplateKey -> TemplateKey

min :: TemplateKey -> TemplateKey -> TemplateKey

Show TemplateKey

Defined in Data.Interpolation

Methods

showsPrec :: Int -> TemplateKey -> ShowS

show :: TemplateKey -> String

showList :: [TemplateKey] -> ShowS

FromJSON TemplateKey

Defined in Data.Interpolation

Methods

parseJSON :: Value -> Parser TemplateKey

parseJSONList :: Value -> Parser [TemplateKey]

ToJSON TemplateKey

Defined in Data.Interpolation

Methods

toJSON :: TemplateKey -> Value

toEncoding :: TemplateKey -> Encoding

toJSONList :: [TemplateKey] -> Value

toEncodingList :: [TemplateKey] -> Encoding

Arbitrary TemplateKey

Defined in Data.Interpolation

Methods

arbitrary :: Gen TemplateKey

shrink :: TemplateKey -> [TemplateKey]

newtype TemplateValue

Newtype wrapper for an environment variable value.

Constructors

TemplateValue

Fields

• unTemplateValue :: Text

Instances

Eq TemplateValue

Defined in Data.Interpolation

Methods

(==) :: TemplateValue -> TemplateValue -> Bool

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

Ord TemplateValue

Defined in Data.Interpolation

Methods

compare :: TemplateValue -> TemplateValue -> Ordering

(<) :: TemplateValue -> TemplateValue -> Bool

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

(>) :: TemplateValue -> TemplateValue -> Bool

(>=) :: TemplateValue -> TemplateValue -> Bool

max :: TemplateValue -> TemplateValue -> TemplateValue

min :: TemplateValue -> TemplateValue -> TemplateValue

Show TemplateValue

Defined in Data.Interpolation

Methods

showsPrec :: Int -> TemplateValue -> ShowS

show :: TemplateValue -> String

showList :: [TemplateValue] -> ShowS

FromJSON TemplateValue

Defined in Data.Interpolation

Methods

parseJSON :: Value -> Parser TemplateValue

parseJSONList :: Value -> Parser [TemplateValue]

ToJSON TemplateValue

Defined in Data.Interpolation

Methods

toJSON :: TemplateValue -> Value

toEncoding :: TemplateValue -> Encoding

toJSONList :: [TemplateValue] -> Value

toEncodingList :: [TemplateValue] -> Encoding

data Template a

Type for a value that is described by '_env:ENVIRONMENT_VARIABLE:default' in JSON.

Constructors

Template

Fields

• _templateKey :: TemplateKey
• _templateDefault :: Maybe a

Instances

Eq a => Eq (Template a)

Defined in Data.Interpolation

Methods

(==) :: Template a -> Template a -> Bool

(/=) :: Template a -> Template a -> Bool

Ord a => Ord (Template a)

Defined in Data.Interpolation

Methods

compare :: Template a -> Template a -> Ordering

(<) :: Template a -> Template a -> Bool

(<=) :: Template a -> Template a -> Bool

(>) :: Template a -> Template a -> Bool

(>=) :: Template a -> Template a -> Bool

max :: Template a -> Template a -> Template a

min :: Template a -> Template a -> Template a

Show a => Show (Template a)

Defined in Data.Interpolation

Methods

showsPrec :: Int -> Template a -> ShowS

show :: Template a -> String

showList :: [Template a] -> ShowS

FromTemplateValue a => FromJSON (Template a)

Defined in Data.Interpolation

Methods

parseJSON :: Value -> Parser (Template a)

parseJSONList :: Value -> Parser [Template a]

ToTemplateValue a => ToJSON (Template a)

Defined in Data.Interpolation

Methods

toJSON :: Template a -> Value

toEncoding :: Template a -> Encoding

toJSONList :: [Template a] -> Value

toEncodingList :: [Template a] -> Encoding

data Uninterpolated a

Type for a value that can be described either with '_env...' or as just a literal value in JSON.

Constructors

Templated (Template a)

Literal a

Instances

Arbitrary1 Uninterpolated

Defined in Data.Interpolation

Methods

liftArbitrary :: Gen a -> Gen (Uninterpolated a)

liftShrink :: (a -> [a]) -> Uninterpolated a -> [Uninterpolated a]

FromTemplateValue a => Default Interpolator (Uninterpolated a) a

When we can parse template values, we can interpolate from the template.

Defined in Data.Interpolation

Methods

def :: Interpolator (Uninterpolated a) a

Eq a => Eq (Uninterpolated a)

Defined in Data.Interpolation

Methods

(==) :: Uninterpolated a -> Uninterpolated a -> Bool

(/=) :: Uninterpolated a -> Uninterpolated a -> Bool

Ord a => Ord (Uninterpolated a)

Defined in Data.Interpolation

Methods

compare :: Uninterpolated a -> Uninterpolated a -> Ordering

(<) :: Uninterpolated a -> Uninterpolated a -> Bool

(<=) :: Uninterpolated a -> Uninterpolated a -> Bool

(>) :: Uninterpolated a -> Uninterpolated a -> Bool

(>=) :: Uninterpolated a -> Uninterpolated a -> Bool

max :: Uninterpolated a -> Uninterpolated a -> Uninterpolated a

min :: Uninterpolated a -> Uninterpolated a -> Uninterpolated a

Show a => Show (Uninterpolated a)

Defined in Data.Interpolation

Methods

showsPrec :: Int -> Uninterpolated a -> ShowS

show :: Uninterpolated a -> String

showList :: [Uninterpolated a] -> ShowS

(FromTemplateValue a, FromJSON a) => FromJSON (Uninterpolated a)

Defined in Data.Interpolation

Methods

parseJSON :: Value -> Parser (Uninterpolated a)

parseJSONList :: Value -> Parser [Uninterpolated a]

(ToTemplateValue a, ToJSON a) => ToJSON (Uninterpolated a)

Defined in Data.Interpolation

Methods

toJSON :: Uninterpolated a -> Value

toEncoding :: Uninterpolated a -> Encoding

toJSONList :: [Uninterpolated a] -> Value

toEncodingList :: [Uninterpolated a] -> Encoding

Arbitrary a => Arbitrary (Uninterpolated a)

Defined in Data.Interpolation

Methods

arbitrary :: Gen (Uninterpolated a)

shrink :: Uninterpolated a -> [Uninterpolated a]

Arbitrary (Uninterpolated Text)

Defined in Data.Interpolation

Methods

arbitrary :: Gen (Uninterpolated Text)

shrink :: Uninterpolated Text -> [Uninterpolated Text]

data InterpolationFailure

Constructors

InterpolationFailureKeyNotFound TemplateKey

InterpolationFailureValueNotReadable TemplateKey TemplateValue

Instances

Eq InterpolationFailure

Defined in Data.Interpolation

Methods

(==) :: InterpolationFailure -> InterpolationFailure -> Bool

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

Ord InterpolationFailure

Defined in Data.Interpolation

Methods

compare :: InterpolationFailure -> InterpolationFailure -> Ordering

(<) :: InterpolationFailure -> InterpolationFailure -> Bool

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

(>) :: InterpolationFailure -> InterpolationFailure -> Bool

(>=) :: InterpolationFailure -> InterpolationFailure -> Bool

max :: InterpolationFailure -> InterpolationFailure -> InterpolationFailure

min :: InterpolationFailure -> InterpolationFailure -> InterpolationFailure

Show InterpolationFailure

Defined in Data.Interpolation

Methods

showsPrec :: Int -> InterpolationFailure -> ShowS

show :: InterpolationFailure -> String

showList :: [InterpolationFailure] -> ShowS

newtype InterpolationContext

Constructors

InterpolationContext

Fields

• unInterpolationContext :: Map TemplateKey TemplateValue

class FromTemplateValue a where

A class for parsing environment variable values, which should only be defined on primitives. Similar to Read except that for text-type values it should parse using identity.

Methods

parseTemplateValue :: TemplateValue -> Maybe a

Instances

FromTemplateValue Bool

Defined in Data.Interpolation

Methods

parseTemplateValue :: TemplateValue -> Maybe Bool

FromTemplateValue Int

Defined in Data.Interpolation

Methods

parseTemplateValue :: TemplateValue -> Maybe Int

FromTemplateValue String

Defined in Data.Interpolation

Methods

parseTemplateValue :: TemplateValue -> Maybe String

FromTemplateValue Text

Defined in Data.Interpolation

Methods

parseTemplateValue :: TemplateValue -> Maybe Text

class ToTemplateValue a where

A class for showing environment variable values, which should only be defined on primitives. Similar to Show except that for text-type values it should use identity.

Methods

toTemplateValue :: a -> TemplateValue

Instances

ToTemplateValue Bool

Defined in Data.Interpolation

Methods

toTemplateValue :: Bool -> TemplateValue

ToTemplateValue Int

Defined in Data.Interpolation

Methods

toTemplateValue :: Int -> TemplateValue

ToTemplateValue String

Defined in Data.Interpolation

Methods

toTemplateValue :: String -> TemplateValue

ToTemplateValue Text

Defined in Data.Interpolation

Methods

toTemplateValue :: Text -> TemplateValue

newtype Interpolator templates identities

Constructors

Interpolator

Fields

• runInterpolator :: templates -> Reader InterpolationContext (Validation [InterpolationFailure] identities)

Instances

Profunctor Interpolator

Defined in Data.Interpolation

Methods

dimap :: (a -> b) -> (c -> d) -> Interpolator b c -> Interpolator a d

lmap :: (a -> b) -> Interpolator b c -> Interpolator a c

rmap :: (b -> c) -> Interpolator a b -> Interpolator a c

(#.) :: Coercible c b => q b c -> Interpolator a b -> Interpolator a c

(.#) :: Coercible b a => Interpolator b c -> q a b -> Interpolator a c

ProductProfunctor Interpolator

Defined in Data.Interpolation

Methods

purePP :: b -> Interpolator a b

(****) :: Interpolator a (b -> c) -> Interpolator a b -> Interpolator a c

empty :: Interpolator () ()

(***!) :: Interpolator a b -> Interpolator a' b' -> Interpolator (a, a') (b, b')

SumProfunctor Interpolator

Defined in Data.Interpolation

Methods

(+++!) :: Interpolator a b -> Interpolator a' b' -> Interpolator (Either a a') (Either b b')

Default Interpolator a a

Pure transformation for the identity interpolation. FIXME this is too clunky for overlapping instances, define an auxiliary class (or type) for IdentityInterpolation.

Defined in Data.Interpolation

Methods

def :: Interpolator a a

FromTemplateValue a => Default Interpolator (Uninterpolated a) a

When we can parse template values, we can interpolate from the template.

Defined in Data.Interpolation

Methods

def :: Interpolator (Uninterpolated a) a

Default Interpolator a b => Default Interpolator [a] [b]

Defined in Data.Interpolation

Methods

def :: Interpolator [a] [b]

Default Interpolator a b => Default Interpolator (Maybe a) (Maybe b)

Defined in Data.Interpolation

Methods

def :: Interpolator (Maybe a) (Maybe b)

(Default Interpolator a b, Ord a, Ord b) => Default Interpolator (Set a) (Set b)

Defined in Data.Interpolation

Methods

def :: Interpolator (Set a) (Set b)

Default Interpolator a b => Default Interpolator (Map k a) (Map k b)

Defined in Data.Interpolation

Methods

def :: Interpolator (Map k a) (Map k b)

Functor (Interpolator templates)

Defined in Data.Interpolation

Methods

fmap :: (a -> b) -> Interpolator templates a -> Interpolator templates b

(<$) :: a -> Interpolator templates b -> Interpolator templates a

Applicative (Interpolator templates)

Defined in Data.Interpolation

Methods

pure :: a -> Interpolator templates a

(<*>) :: Interpolator templates (a -> b) -> Interpolator templates a -> Interpolator templates b

liftA2 :: (a -> b -> c) -> Interpolator templates a -> Interpolator templates b -> Interpolator templates c

(*>) :: Interpolator templates a -> Interpolator templates b -> Interpolator templates b

(<*) :: Interpolator templates a -> Interpolator templates b -> Interpolator templates a

runTemplate :: FromTemplateValue a => Interpolator (Uninterpolated a) a

Run a template using the interpolation context and failing if the value is not found or not readable.

mkInterpolationContext :: MonadIO m => m InterpolationContext

interpolateWithContext :: (Default Interpolator templates identities, MonadIO m) => templates -> m (Either [InterpolationFailure] identities)

interpolateWithContextExplicit :: MonadIO m => Interpolator templates identities -> templates -> m (Either [InterpolationFailure] identities)