Text.Format

Format string with named args

-- Named args
"My name is {name}, I am {age} years old" ~~ ("name" ~% "Joe") ~~ ("age" ~% 24) ≡ "My name is Joe, I am 24 years old"
-- Arg can have default value
"{var:x} = {val:10}" ~~ ("var" ~% y) ≡ "y = 10"
-- Numeric position can be used
"{0} {1} {0}" ~~ "foo" ~~ "bar" ≡ "foo bar foo"
-- Positions can be omitted
"{} {}" ~~ "foo" ~~ 10 ≡ "foo 10"
-- Double braces to escape them
"{} and {{}}" ~~ 10 ≡ "10 and {}"

Documentation

data FormattedPart

Constructors

FormattedPart

Fields

• formattedFlags :: FormatFlags
• formattedValue :: String

Instances

Eq FormattedPart

Defined in Text.Format

Methods

(==) :: FormattedPart -> FormattedPart -> Bool

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

Ord FormattedPart

Defined in Text.Format

Methods

compare :: FormattedPart -> FormattedPart -> Ordering

(<) :: FormattedPart -> FormattedPart -> Bool

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

(>) :: FormattedPart -> FormattedPart -> Bool

(>=) :: FormattedPart -> FormattedPart -> Bool

max :: FormattedPart -> FormattedPart -> FormattedPart

min :: FormattedPart -> FormattedPart -> FormattedPart

Show FormattedPart

Defined in Text.Format

Methods

showsPrec :: Int -> FormattedPart -> ShowS

show :: FormattedPart -> String

showList :: [FormattedPart] -> ShowS

IsString FormattedPart

Defined in Text.Format

Methods

fromString :: String -> FormattedPart

newtype Formatted

Constructors

Formatted

Fields

• formattedParts :: [FormattedPart]

Instances

Eq Formatted

Defined in Text.Format

Methods

(==) :: Formatted -> Formatted -> Bool

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

Ord Formatted

Defined in Text.Format

Methods

compare :: Formatted -> Formatted -> Ordering

(<) :: Formatted -> Formatted -> Bool

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

(>) :: Formatted -> Formatted -> Bool

(>=) :: Formatted -> Formatted -> Bool

max :: Formatted -> Formatted -> Formatted

min :: Formatted -> Formatted -> Formatted

Show Formatted

Defined in Text.Format

Methods

showsPrec :: Int -> Formatted -> ShowS

show :: Formatted -> String

showList :: [Formatted] -> ShowS

IsString Formatted

Defined in Text.Format

Methods

fromString :: String -> Formatted

Semigroup Formatted

Defined in Text.Format

Methods

(<>) :: Formatted -> Formatted -> Formatted

sconcat :: NonEmpty Formatted -> Formatted

stimes :: Integral b => b -> Formatted -> Formatted

Monoid Formatted

Defined in Text.Format

Methods

mempty :: Formatted

mappend :: Formatted -> Formatted -> Formatted

mconcat :: [Formatted] -> Formatted

FormatResult Formatted

Defined in Text.Format

Methods

formatResult :: Format -> Formatted

Hole Formatted

Defined in Text.Format

Methods

hole :: Formatted -> [FormatArg]

withFlags :: String -> [String] -> Formatted

data FormatArg

Constructors

FormatNamed String ([String] -> Formatted)

FormatPos ([String] -> Formatted)

Instances

Hole FormatArg

Defined in Text.Format

Methods

hole :: FormatArg -> [FormatArg]

Hole [[FormatArg]]

Defined in Text.Format

Methods

hole :: [[FormatArg]] -> [FormatArg]

Hole [FormatArg]

Defined in Text.Format

Methods

hole :: [FormatArg] -> [FormatArg]

data Format

Constructors

Format

Fields

• formatString :: String
• formatArgs :: [FormatArg]

Instances

Show Format

Defined in Text.Format

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

IsString Format

Defined in Text.Format

Methods

fromString :: String -> Format

FormatResult Format

Defined in Text.Format

Methods

formatResult :: Format -> Format

data Formatter

Constructors

Formatter

Fields

• formatter :: Either String Int
• formatterDefault :: Maybe String
• formatterFlags :: [String]

Instances

Read Formatter

Defined in Text.Format

Methods

readsPrec :: Int -> ReadS Formatter

readList :: ReadS [Formatter]

readPrec :: ReadPrec Formatter

readListPrec :: ReadPrec [Formatter]

Show Formatter

Defined in Text.Format

Methods

showsPrec :: Int -> Formatter -> ShowS

show :: Formatter -> String

showList :: [Formatter] -> ShowS

Formattable Formatter

Defined in Text.Format

Methods

formattable :: Formatter -> FormatFlags -> Formatted

prebuild :: Format -> Formatted

build :: Format -> Formatted

getNamedArguments :: Format -> [String]

class Formattable a where

Formattable class, by default using show

Methods

formattable :: a -> FormatFlags -> Formatted

formattable :: Show a => a -> FormatFlags -> Formatted

Instances

Formattable Bool

Defined in Text.Format

Methods

formattable :: Bool -> FormatFlags -> Formatted

Formattable Char

Defined in Text.Format

Methods

formattable :: Char -> FormatFlags -> Formatted

Formattable Double

Defined in Text.Format

Methods

formattable :: Double -> FormatFlags -> Formatted

Formattable Float

Defined in Text.Format

Methods

formattable :: Float -> FormatFlags -> Formatted

Formattable Int

Defined in Text.Format

Methods

formattable :: Int -> FormatFlags -> Formatted

Formattable Integer

Defined in Text.Format

Methods

formattable :: Integer -> FormatFlags -> Formatted

Formattable String

Defined in Text.Format

Methods

formattable :: String -> FormatFlags -> Formatted

Formattable Text

Defined in Text.Format

Methods

formattable :: Text -> FormatFlags -> Formatted

Formattable Text

Defined in Text.Format

Methods

formattable :: Text -> FormatFlags -> Formatted

Formattable Formatter

Defined in Text.Format

Methods

formattable :: Formatter -> FormatFlags -> Formatted

class Hole a where

Minimal complete definition

hole

Methods

hole :: a -> [FormatArg]

Instances

Formattable a => Hole a

Defined in Text.Format

Methods

hole :: a -> [FormatArg]

Hole FormatArg

Defined in Text.Format

Methods

hole :: FormatArg -> [FormatArg]

Hole Formatted

Defined in Text.Format

Methods

hole :: Formatted -> [FormatArg]

Hole [[FormatArg]]

Defined in Text.Format

Methods

hole :: [[FormatArg]] -> [FormatArg]

Hole [FormatArg]

Defined in Text.Format

Methods

hole :: [FormatArg] -> [FormatArg]

fmt :: Formattable a => a -> FormatArg

class FormatResult r where

Minimal complete definition

formatResult

Methods

formatResult :: Format -> r

Instances

IsString s => FormatResult s

Defined in Text.Format

Methods

formatResult :: Format -> s

FormatResult String

Defined in Text.Format

Methods

formatResult :: Format -> String

FormatResult Format

Defined in Text.Format

Methods

formatResult :: Format -> Format

FormatResult Formatted

Defined in Text.Format

Methods

formatResult :: Format -> Formatted

format :: FormatResult r => String -> r

formats :: FormatResult r => String -> [FormatArg] -> r

(~~) :: (Hole a, FormatResult r) => Format -> a -> r infixl 7

(~%) :: Formattable a => String -> a -> FormatArg infixr 8

module Text.Format.Flags