Data.Text.Format.Heavy.Types

This module contains basic type definitions

Documentation

type VarName = Text

Variable name

type VarFormat = Maybe Text

Variable format in text form. Nothing means default format.

data FormatItem

String format item.

Constructors

FString Text

Verbatim text

FVariable

Fields

• vName :: VarName

  Variable name

• vFormat :: VarFormat

  Variable format

Instances

Eq FormatItem

Defined in Data.Text.Format.Heavy.Types

Methods

(==) :: FormatItem -> FormatItem -> Bool

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

Show FormatItem

Defined in Data.Text.Format.Heavy.Types

Methods

showsPrec :: Int -> FormatItem -> ShowS

show :: FormatItem -> String

showList :: [FormatItem] -> ShowS

data Format

String format

Constructors

Format [FormatItem]

Instances

Eq Format

Defined in Data.Text.Format.Heavy.Types

Methods

(==) :: Format -> Format -> Bool

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

Show Format

Defined in Data.Text.Format.Heavy.Types

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

IsString Format

Defined in Data.Text.Format.Heavy.Instances

Methods

fromString :: String -> Format

Semigroup Format

Defined in Data.Text.Format.Heavy.Types

Methods

(<>) :: Format -> Format -> Format

sconcat :: NonEmpty Format -> Format

stimes :: Integral b => b -> Format -> Format

Monoid Format

Defined in Data.Text.Format.Heavy.Types

Methods

mempty :: Format

mappend :: Format -> Format -> Format

mconcat :: [Format] -> Format

appendFormat :: Format -> Format -> Format

class (Default f, Show f) => IsVarFormat f where

Can be used for different data types describing formats of specific types.

Minimal complete definition

parseVarFormat

Methods

parseVarFormat :: Text -> Either String f

Left for errors.

Instances

IsVarFormat ()

Defined in Data.Text.Format.Heavy.Types

Methods

parseVarFormat :: Text -> Either String ()

IsVarFormat BoolFormat

Defined in Data.Text.Format.Heavy.Instances

Methods

parseVarFormat :: Text -> Either String BoolFormat

IsVarFormat GenericFormat

Defined in Data.Text.Format.Heavy.Instances

Methods

parseVarFormat :: Text -> Either String GenericFormat

class Formatable a where

Value that can be formatted to be substituted into format string.

Minimal complete definition

formatVar

Methods

formatVar

Arguments

:: VarFormat

Variable format specification in text form. Nothing is for default format.

-> a

Variable value.

-> Either String Builder

Left for errors in variable format syntax, or errors during formatting.

Format variable according to format specification. This function should usually parse format specification by itself.

Instances

Formatable Bool

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Bool -> Either String Builder

Formatable Double

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Double -> Either String Builder

Formatable Float

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Float -> Either String Builder

Formatable Int

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Int -> Either String Builder

Formatable Int8

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Int8 -> Either String Builder

Formatable Int16

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Int16 -> Either String Builder

Formatable Int32

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Int32 -> Either String Builder

Formatable Int64

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Int64 -> Either String Builder

Formatable Integer

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Integer -> Either String Builder

Formatable Word8

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Word8 -> Either String Builder

Formatable Word16

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Word16 -> Either String Builder

Formatable Word32

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Word32 -> Either String Builder

Formatable Word64

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Word64 -> Either String Builder

Formatable ()

Unit type is formatted as empty string

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> () -> Either String Builder

Formatable String

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> String -> Either String Builder

Formatable ByteString

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> ByteString -> Either String Builder

Formatable ByteString

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> ByteString -> Either String Builder

Formatable Text

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Text -> Either String Builder

Formatable Text

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Text -> Either String Builder

Formatable ZonedTime

Defined in Data.Text.Format.Heavy.Time

Methods

formatVar :: VarFormat -> ZonedTime -> Either String Builder

Formatable LocalTime

Defined in Data.Text.Format.Heavy.Time

Methods

formatVar :: VarFormat -> LocalTime -> Either String Builder

Formatable TimeOfDay

Defined in Data.Text.Format.Heavy.Time

Methods

formatVar :: VarFormat -> TimeOfDay -> Either String Builder

Formatable TimeZone

Defined in Data.Text.Format.Heavy.Time

Methods

formatVar :: VarFormat -> TimeZone -> Either String Builder

Formatable UTCTime

Defined in Data.Text.Format.Heavy.Time

Methods

formatVar :: VarFormat -> UTCTime -> Either String Builder

Formatable Day

Defined in Data.Text.Format.Heavy.Time

Methods

formatVar :: VarFormat -> Day -> Either String Builder

Formatable Variable

Defined in Data.Text.Format.Heavy.Types

Methods

formatVar :: VarFormat -> Variable -> Either String Builder

Formatable a => Formatable (Maybe a)

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Maybe a -> Either String Builder

Show a => Formatable (Shown a)

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Shown a -> Either String Builder

Formatable a => Formatable (Single a)

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Single a -> Either String Builder

(Formatable a, Formatable b) => Formatable (Either a b)

Defined in Data.Text.Format.Heavy.Instances

Methods

formatVar :: VarFormat -> Either a b -> Either String Builder

data Variable

Any variable that can be substituted. This type may be also used to construct heterogeneous lists: [Variable 1, Variable "x"] :: [Variable].

Constructors

Formatable a => Variable a

Instances

Show Variable

Defined in Data.Text.Format.Heavy.Types

Methods

showsPrec :: Int -> Variable -> ShowS

show :: Variable -> String

showList :: [Variable] -> ShowS

Formatable Variable

Defined in Data.Text.Format.Heavy.Types

Methods

formatVar :: VarFormat -> Variable -> Either String Builder

formatAnyVar :: VarFormat -> Variable -> Either String Builder

Format one variable according to format specification.

class VarContainer c where

Data structure that contains some number of variables.

Minimal complete definition

lookupVar

Methods

lookupVar :: VarName -> c -> Maybe Variable

Instances

VarContainer ()

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> () -> Maybe Variable

VarContainer DefaultValue

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> DefaultValue -> Maybe Variable

Formatable x => VarContainer [(Text, x)]

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> [(Text, x)] -> Maybe Variable

Formatable a => VarContainer (Maybe a)

Maybe container contains one variable (named 0); Nothing contains an empty string.

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> Maybe a -> Maybe Variable

Formatable a => VarContainer (Several a)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> Several a -> Maybe Variable

Formatable a => VarContainer (Single a)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> Single a -> Maybe Variable

(Formatable a, Formatable b) => VarContainer (a, b)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b) -> Maybe Variable

Formatable x => VarContainer (Map Text x)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> Map Text x -> Maybe Variable

(VarContainer c1, VarContainer c2) => VarContainer (ThenCheck c1 c2)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> ThenCheck c1 c2 -> Maybe Variable

(Formatable a, Formatable b, Formatable c) => VarContainer (a, b, c)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d) => VarContainer (a, b, c, d)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c, d) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e) => VarContainer (a, b, c, d, e)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c, d, e) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f) => VarContainer (a, b, c, d, e, f)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c, d, e, f) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g) => VarContainer (a, b, c, d, e, f, g)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c, d, e, f, g) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g, Formatable h) => VarContainer (a, b, c, d, e, f, g, h)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c, d, e, f, g, h) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g, Formatable h, Formatable i) => VarContainer (a, b, c, d, e, f, g, h, i)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c, d, e, f, g, h, i) -> Maybe Variable

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g, Formatable h, Formatable i, Formatable j) => VarContainer (a, b, c, d, e, f, g, h, i, j)

Defined in Data.Text.Format.Heavy.Instances

Methods

lookupVar :: VarName -> (a, b, c, d, e, f, g, h, i, j) -> Maybe Variable

class VarContainer c => ClosedVarContainer c where

Minimal complete definition

allVarNames

Methods

allVarNames :: c -> [VarName]

Instances

ClosedVarContainer ()

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: () -> [VarName]

Formatable x => ClosedVarContainer [(Text, x)]

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: [(Text, x)] -> [VarName]

Formatable a => ClosedVarContainer (Maybe a)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: Maybe a -> [VarName]

Formatable a => ClosedVarContainer (Several a)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: Several a -> [VarName]

Formatable a => ClosedVarContainer (Single a)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: Single a -> [VarName]

(Formatable a, Formatable b) => ClosedVarContainer (a, b)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b) -> [VarName]

Formatable x => ClosedVarContainer (Map Text x)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: Map Text x -> [VarName]

(ClosedVarContainer c1, ClosedVarContainer c2) => ClosedVarContainer (ThenCheck c1 c2)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: ThenCheck c1 c2 -> [VarName]

(Formatable a, Formatable b, Formatable c) => ClosedVarContainer (a, b, c)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c) -> [VarName]

(Formatable a, Formatable b, Formatable c, Formatable d) => ClosedVarContainer (a, b, c, d)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c, d) -> [VarName]

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e) => ClosedVarContainer (a, b, c, d, e)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c, d, e) -> [VarName]

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f) => ClosedVarContainer (a, b, c, d, e, f)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c, d, e, f) -> [VarName]

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g) => ClosedVarContainer (a, b, c, d, e, f, g)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c, d, e, f, g) -> [VarName]

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g, Formatable h) => ClosedVarContainer (a, b, c, d, e, f, g, h)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c, d, e, f, g, h) -> [VarName]

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g, Formatable h, Formatable i) => ClosedVarContainer (a, b, c, d, e, f, g, h, i)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c, d, e, f, g, h, i) -> [VarName]

(Formatable a, Formatable b, Formatable c, Formatable d, Formatable e, Formatable f, Formatable g, Formatable h, Formatable i, Formatable j) => ClosedVarContainer (a, b, c, d, e, f, g, h, i, j)

Defined in Data.Text.Format.Heavy.Instances

Methods

allVarNames :: (a, b, c, d, e, f, g, h, i, j) -> [VarName]