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

Methods

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

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

Show FormatItem

Methods

showsPrec :: Int -> FormatItem -> ShowS

show :: FormatItem -> String

showList :: [FormatItem] -> ShowS

data Format

String format

Constructors

Format [FormatItem]

Instances

Eq Format

Methods

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

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

Show Format

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

Monoid Format

Methods

mempty :: Format

mappend :: Format -> Format -> Format

mconcat :: [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 ()

Methods

parseVarFormat :: Text -> Either String ()

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 Variable

Methods

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

Show a => Formatable (Shown a)

Methods

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

Formatable a => Formatable (Single a)

Methods

formatVar :: VarFormat -> Single a -> 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

Methods

showsPrec :: Int -> Variable -> ShowS

show :: Variable -> String

showList :: [Variable] -> ShowS

Formatable Variable

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 DefaultValue

Methods

lookupVar :: VarName -> DefaultValue -> Maybe Variable

Formatable a => VarContainer (Several a)

Methods

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

Formatable a => VarContainer (Single a)

Methods

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

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

Methods

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

class VarContainer c => ClosedVarContainer c where

Minimal complete definition

allVarNames

Methods

allVarNames :: c -> [VarName]

Instances

Formatable a => ClosedVarContainer (Several a)

Methods

allVarNames :: Several a -> [VarName]

Formatable a => ClosedVarContainer (Single a)

Methods

allVarNames :: Single a -> [VarName]

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

Methods

allVarNames :: ThenCheck c1 c2 -> [VarName]