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

Show FormatItem

Methods

showsPrec :: Int -> FormatItem -> ShowS

show :: FormatItem -> String

showList :: [FormatItem] -> ShowS

data Format

String format

Constructors

Format [FormatItem]

Instances

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 :: VarFormat -> a -> Either String Builder

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

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