text-builder-0.6.7.1: Efficient strict text builder

Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.Builder

Contents

Accessors
- Output IO
Constructors

Synopsis

data Builder
run :: Builder -> Text
length :: Builder -> Int
null :: Builder -> Bool
putToStdOut :: Builder -> IO ()
putToStdErr :: Builder -> IO ()
putLnToStdOut :: Builder -> IO ()
putLnToStdErr :: Builder -> IO ()
intercalate :: Foldable foldable => Builder -> foldable Builder -> Builder
padFromLeft :: Int -> Char -> Builder -> Builder
padFromRight :: Int -> Char -> Builder -> Builder
text :: Text -> Builder
lazyText :: Text -> Builder
string :: String -> Builder
asciiByteString :: ByteString -> Builder
hexData :: ByteString -> Builder
char :: Char -> Builder
unicodeCodePoint :: Int -> Builder
utf16CodeUnits1 :: Word16 -> Builder
utf16CodeUnits2 :: Word16 -> Word16 -> Builder
utf8CodeUnits1 :: Word8 -> Builder
utf8CodeUnits2 :: Word8 -> Word8 -> Builder
utf8CodeUnits3 :: Word8 -> Word8 -> Word8 -> Builder
utf8CodeUnits4 :: Word8 -> Word8 -> Word8 -> Word8 -> Builder
decimal :: Integral a => a -> Builder
unsignedDecimal :: Integral a => a -> Builder
thousandSeparatedDecimal :: Integral a => Char -> a -> Builder
thousandSeparatedUnsignedDecimal :: Integral a => Char -> a -> Builder
dataSizeInBytesInDecimal :: Integral a => Char -> a -> Builder
unsignedBinary :: Integral a => a -> Builder
unsignedPaddedBinary :: (Integral a, FiniteBits a) => a -> Builder
hexadecimal :: Integral a => a -> Builder
unsignedHexadecimal :: Integral a => a -> Builder
decimalDigit :: Integral a => a -> Builder
hexadecimalDigit :: Integral a => a -> Builder
fixedDouble :: Int -> Double -> Builder
doublePercent :: Int -> Double -> Builder
intervalInSeconds :: RealFrac seconds => seconds -> Builder

Documentation

data Builder Source #

Specification of how to efficiently construct strict Text. Provides instances of Semigroup and Monoid, which have complexity of O(1).

Instances

Instances details

IsString Builder Source #
Instance details Defined in Text.Builder Methods fromString :: String -> Builder
Monoid Builder Source #
Instance details Defined in Text.Builder Methods mempty :: Builder mappend :: Builder -> Builder -> Builder mconcat :: [Builder] -> Builder
Semigroup Builder Source #
Instance details Defined in Text.Builder Methods (<>) :: Builder -> Builder -> Builder sconcat :: NonEmpty Builder -> Builder stimes :: Integral b => b -> Builder -> Builder
Show Builder Source #
Instance details Defined in Text.Builder Methods showsPrec :: Int -> Builder -> ShowS show :: Builder -> String showList :: [Builder] -> ShowS

Accessors

run :: Builder -> Text Source #

Execute a builder producing a strict text

length :: Builder -> Int Source #

Get the amount of characters

null :: Builder -> Bool Source #

Check whether the builder is empty

Output IO

putToStdOut :: Builder -> IO () Source #

Put builder, to stdout

putToStdErr :: Builder -> IO () Source #

Put builder, to stderr

putLnToStdOut :: Builder -> IO () Source #

Put builder, followed by a line, to stdout

putLnToStdErr :: Builder -> IO () Source #

Put builder, followed by a line, to stderr

Constructors

Builder manipulators

intercalate :: Foldable foldable => Builder -> foldable Builder -> Builder Source #

Intercalate builders

padFromLeft :: Int -> Char -> Builder -> Builder Source #

Pad a builder from the left side to the specified length with the specified character

padFromRight :: Int -> Char -> Builder -> Builder Source #

Pad a builder from the right side to the specified length with the specified character

Textual

text :: Text -> Builder Source #

Strict text

lazyText :: Text -> Builder Source #

Lazy text

string :: String -> Builder Source #

String

asciiByteString :: ByteString -> Builder Source #

ASCII byte string

hexData :: ByteString -> Builder Source #

Hexadecimal readable representation of binary data.

Character

char :: Char -> Builder Source #

Unicode character

Low-level character

unicodeCodePoint :: Int -> Builder Source #

Unicode code point

utf16CodeUnits1 :: Word16 -> Builder Source #

Single code-unit UTF-16 character

utf16CodeUnits2 :: Word16 -> Word16 -> Builder Source #

Double code-unit UTF-16 character

utf8CodeUnits1 :: Word8 -> Builder Source #

Single code-unit UTF-8 character

utf8CodeUnits2 :: Word8 -> Word8 -> Builder Source #

Double code-unit UTF-8 character

utf8CodeUnits3 :: Word8 -> Word8 -> Word8 -> Builder Source #

Triple code-unit UTF-8 character

utf8CodeUnits4 :: Word8 -> Word8 -> Word8 -> Word8 -> Builder Source #

UTF-8 character out of 4 code units

Integers

Decimal

decimal :: Integral a => a -> Builder Source #

Decimal representation of an integral value

unsignedDecimal :: Integral a => a -> Builder Source #

Decimal representation of an unsigned integral value

thousandSeparatedDecimal :: Integral a => Char -> a -> Builder Source #

Decimal representation of an integral value with thousands separated by the specified character

thousandSeparatedUnsignedDecimal :: Integral a => Char -> a -> Builder Source #

Decimal representation of an unsigned integral value with thousands separated by the specified character

dataSizeInBytesInDecimal :: Integral a => Char -> a -> Builder Source #

Data size in decimal notation over amount of bytes.

Binary

unsignedBinary :: Integral a => a -> Builder Source #

Unsigned binary number

unsignedPaddedBinary :: (Integral a, FiniteBits a) => a -> Builder Source #

Unsigned binary number

Hexadecimal

hexadecimal :: Integral a => a -> Builder Source #

Hexadecimal representation of an integral value

unsignedHexadecimal :: Integral a => a -> Builder Source #

Unsigned hexadecimal representation of an integral value

Digits

decimalDigit :: Integral a => a -> Builder Source #

Decimal digit

hexadecimalDigit :: Integral a => a -> Builder Source #

Hexadecimal digit

Real

fixedDouble Source #

Arguments

:: Int	Amount of decimals after point.
-> Double
-> Builder

Double with a fixed number of decimal places.

doublePercent Source #

Arguments

:: Int	Amount of decimals after point.
-> Double
-> Builder

Double multiplied by 100 with a fixed number of decimal places applied and followed by a percent-sign.

Time

intervalInSeconds :: RealFrac seconds => seconds -> Builder Source #

Time interval in seconds. Directly applicable to DiffTime and NominalDiffTime.