Data.Text.Interp.Types

Types shared among other modules

Documentation

data Binding

A binding of a Key to a path of Keys

Constructors

Binding

Fields

• name :: Key
• pathToBind :: NonEmpty Key

Instances

Eq Binding

Defined in Data.Text.Interp.Types

Methods

(==) :: Binding -> Binding -> Bool

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

Show Binding

Defined in Data.Text.Interp.Types

Methods

showsPrec :: Int -> Binding -> ShowS

show :: Binding -> String

showList :: [Binding] -> ShowS

type BindingMap = Map Key Subst

type I = ExceptT Text IO

data IText

A segment of text to interpolate (or not)

Constructors

RawText Text

Raw text that doesn't need interpolation | Text that requires interpolation

ToInterpolate

Fields

• binding :: Maybe Binding

  Optional binding

• path :: [Key]

  Path of Keys to the value to interpolate

Instances

Eq IText

Defined in Data.Text.Interp.Types

Methods

(==) :: IText -> IText -> Bool

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

Show IText

Defined in Data.Text.Interp.Types

Methods

showsPrec :: Int -> IText -> ShowS

show :: IText -> String

showList :: [IText] -> ShowS

newtype Key

Constructors

Key

Fields

• unKey :: Text

Instances

Eq Key

Defined in Data.Text.Interp.Types

Methods

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

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

Ord Key

Defined in Data.Text.Interp.Types

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 Data.Text.Interp.Types

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

IsString Key

Defined in Data.Text.Interp.Types

Methods

fromString :: String -> Key

Semigroup Key

Defined in Data.Text.Interp.Types

Methods

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

sconcat :: NonEmpty Key -> Key

stimes :: Integral b => b -> Key -> Key

Monoid Key

Defined in Data.Text.Interp.Types

Methods

mempty :: Key

mappend :: Key -> Key -> Key

mconcat :: [Key] -> Key

data Subst

The main substitution type, either a list, mapping, or single value

Constructors

SubstL [Subst]

a list of values, one of which will be randomly selected

SubstM (Map Key Subst)

a mapping of Keys to values

SubstV Text

a single value

Instances

Eq Subst

Defined in Data.Text.Interp.Types

Methods

(==) :: Subst -> Subst -> Bool

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

Show Subst

Defined in Data.Text.Interp.Types

Methods

showsPrec :: Int -> Subst -> ShowS

show :: Subst -> String

showList :: [Subst] -> ShowS

FromJSON Subst

Defined in Data.Text.Interp.Types

Methods

parseJSON :: Value -> Parser Subst

parseJSONList :: Value -> Parser [Subst]

substm :: [(Key, Subst)] -> Subst

Helper function to build a Subst mapping