Copyright	(c) Dong Han 2017-2019
License	BSD
Maintainer	winterland1989@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Std.Data.TextBuilder

Contents

Textual Builder
Basic UTF8 builders
Numeric builders

Description

UTF8 compatible textual builders.

Synopsis

newtype TextBuilder a = TextBuilder {
- toBuilder :: Builder a
}
buildText :: TextBuilder a -> Text
stringUTF8 :: String -> TextBuilder ()
charUTF8 :: Char -> TextBuilder ()
string7 :: String -> TextBuilder ()
char7 :: Char -> TextBuilder ()
text :: Text -> TextBuilder ()
data IFormat = IFormat {
- width :: Int
- padding :: Padding
- postiveSign :: Bool
}
defaultIFormat :: IFormat
data Padding
- = NoPadding
- | ZeroPadding
- | LeftSpacePadding
- | RightSpacePadding
int :: (Integral a, Bounded a) => a -> TextBuilder ()
intWith :: (Integral a, Bounded a) => IFormat -> a -> TextBuilder ()
integer :: Integer -> TextBuilder ()
hex :: (FiniteBits a, Integral a) => a -> TextBuilder ()
heX :: (FiniteBits a, Integral a) => a -> TextBuilder ()
data FFormat
- = Exponent
- | Fixed
- | Generic
double :: Double -> TextBuilder ()
doubleWith :: FFormat -> Maybe Int -> Double -> TextBuilder ()
float :: Float -> TextBuilder ()
floatWith :: FFormat -> Maybe Int -> Float -> TextBuilder ()
scientific :: Scientific -> TextBuilder ()
scientificWith :: FFormat -> Maybe Int -> Scientific -> TextBuilder ()

Textual Builder

newtype TextBuilder a Source #

Buidlers which guarantee UTF-8 encoding, thus can be used to build text directly.

Notes on IsString instance: It's recommended to use IsString instance instead of stringUTF8 or string7 since there's a rewrite rule to turn encoding loop into a memcpy, which is much faster.

Different from 'Builder ()', 'TextBuilder ()''s IsString instance will gives desired UTF8 guarantees:

"NUL" will be written directly as x00.
xD800 ~ xDFFF will be replaced by replacement char.

Constructors

TextBuilder
Fields toBuilder :: Builder a

Instances

Monad TextBuilder Source #
Instance details Defined in Std.Data.TextBuilder Methods (>>=) :: TextBuilder a -> (a -> TextBuilder b) -> TextBuilder b # (>>) :: TextBuilder a -> TextBuilder b -> TextBuilder b # return :: a -> TextBuilder a # fail :: String -> TextBuilder a #
Functor TextBuilder Source #
Instance details Defined in Std.Data.TextBuilder Methods fmap :: (a -> b) -> TextBuilder a -> TextBuilder b # (<$) :: a -> TextBuilder b -> TextBuilder a #
Applicative TextBuilder Source #
Instance details Defined in Std.Data.TextBuilder Methods pure :: a -> TextBuilder a # (<>) :: TextBuilder (a -> b) -> TextBuilder a -> TextBuilder b # liftA2 :: (a -> b -> c) -> TextBuilder a -> TextBuilder b -> TextBuilder c # (>) :: TextBuilder a -> TextBuilder b -> TextBuilder b # (<*) :: TextBuilder a -> TextBuilder b -> TextBuilder a #
a ~ () => IsString (TextBuilder a) Source #
Instance details Defined in Std.Data.TextBuilder Methods fromString :: String -> TextBuilder a #
Semigroup (TextBuilder ()) Source #
Instance details Defined in Std.Data.TextBuilder Methods (<>) :: TextBuilder () -> TextBuilder () -> TextBuilder () # sconcat :: NonEmpty (TextBuilder ()) -> TextBuilder () # stimes :: Integral b => b -> TextBuilder () -> TextBuilder () #
Monoid (TextBuilder ()) Source #
Instance details Defined in Std.Data.TextBuilder Methods mempty :: TextBuilder () # mappend :: TextBuilder () -> TextBuilder () -> TextBuilder () # mconcat :: [TextBuilder ()] -> TextBuilder () #

buildText :: TextBuilder a -> Text Source #

Basic UTF8 builders

stringUTF8 :: String -> TextBuilder () Source #

Turn String into TextBuilder with UTF8 encoding

Illegal codepoints will be written as replacementChars. This function will be rewritten into a memcpy if possible, (running a fast UTF-8 validation at runtime first).

charUTF8 :: Char -> TextBuilder () Source #

Turn Char into TextBuilder with UTF8 encoding

Illegal codepoints will be written as replacementChars.

string7 :: String -> TextBuilder () Source #

Turn String into TextBuilder with ASCII7 encoding

Codepoints beyond '\x7F' will be chopped.

char7 :: Char -> TextBuilder () Source #

Turn Char into TextBuilder with ASCII7 encoding

Codepoints beyond '\x7F' will be chopped.

text :: Text -> TextBuilder () Source #

Write UTF8 encoded Text using Builder.

Note, if you're trying to write string literals builders, please open OverloadedStrings and use Builders IsString instance, it will be rewritten into a memcpy.

Numeric builders

Integral type formatting

data IFormat Source #

Integral formatting options.

Constructors

IFormat
Fields width :: Int total width, only effective with padding options padding :: Padding padding options postiveSign :: Bool show `+` when the number is positive

Instances

Eq IFormat Source #
Instance details Defined in Std.Data.Builder.Numeric Methods (==) :: IFormat -> IFormat -> Bool # (/=) :: IFormat -> IFormat -> Bool #
Ord IFormat Source #
Instance details Defined in Std.Data.Builder.Numeric Methods compare :: IFormat -> IFormat -> Ordering # (<) :: IFormat -> IFormat -> Bool # (<=) :: IFormat -> IFormat -> Bool # (>) :: IFormat -> IFormat -> Bool # (>=) :: IFormat -> IFormat -> Bool # max :: IFormat -> IFormat -> IFormat # min :: IFormat -> IFormat -> IFormat #
Show IFormat Source #
Instance details Defined in Std.Data.Builder.Numeric Methods showsPrec :: Int -> IFormat -> ShowS # show :: IFormat -> String # showList :: [IFormat] -> ShowS #

defaultIFormat :: IFormat Source #

defaultIFormat = IFormat 0 NoPadding False Decimal

data Padding Source #

Constructors

NoPadding
ZeroPadding
LeftSpacePadding
RightSpacePadding

Instances

Eq Padding Source #
Instance details Defined in Std.Data.Builder.Numeric Methods (==) :: Padding -> Padding -> Bool # (/=) :: Padding -> Padding -> Bool #
Ord Padding Source #
Instance details Defined in Std.Data.Builder.Numeric Methods compare :: Padding -> Padding -> Ordering # (<) :: Padding -> Padding -> Bool # (<=) :: Padding -> Padding -> Bool # (>) :: Padding -> Padding -> Bool # (>=) :: Padding -> Padding -> Bool # max :: Padding -> Padding -> Padding # min :: Padding -> Padding -> Padding #
Show Padding Source #
Instance details Defined in Std.Data.Builder.Numeric Methods showsPrec :: Int -> Padding -> ShowS # show :: Padding -> String # showList :: [Padding] -> ShowS #

int :: (Integral a, Bounded a) => a -> TextBuilder () Source #

int = intWith defaultIFormat

intWith :: (Integral a, Bounded a) => IFormat -> a -> TextBuilder () Source #

Format a Bounded Integral type like Int or Word16 into decimal ascii digits.

integer :: Integer -> TextBuilder () Source #

Format a Integer into decimal ascii digits.

Fixded size hexidecimal formatting

hex :: (FiniteBits a, Integral a) => a -> TextBuilder () Source #

Format a FiniteBits Integral type into hex nibbles.

heX :: (FiniteBits a, Integral a) => a -> TextBuilder () Source #

The UPPERCASED version of hex.

IEEE float formating

data FFormat Source #

Control the rendering of floating point numbers.

Constructors

Exponent	Scientific notation (e.g. `2.3e123`).
Fixed	Standard decimal notation.
Generic	Use decimal notation for values between `0.1` and `9,999,999`, and scientific notation otherwise.

Instances

Enum FFormat Source #
Instance details Defined in Std.Data.Builder.Numeric Methods succ :: FFormat -> FFormat # pred :: FFormat -> FFormat # toEnum :: Int -> FFormat # fromEnum :: FFormat -> Int # enumFrom :: FFormat -> [FFormat] # enumFromThen :: FFormat -> FFormat -> [FFormat] # enumFromTo :: FFormat -> FFormat -> [FFormat] # enumFromThenTo :: FFormat -> FFormat -> FFormat -> [FFormat] #
Read FFormat Source #
Instance details Defined in Std.Data.Builder.Numeric Methods readsPrec :: Int -> ReadS FFormat # readList :: ReadS [FFormat] # readPrec :: ReadPrec FFormat # readListPrec :: ReadPrec [FFormat] #
Show FFormat Source #
Instance details Defined in Std.Data.Builder.Numeric Methods showsPrec :: Int -> FFormat -> ShowS # show :: FFormat -> String # showList :: [FFormat] -> ShowS #

double :: Double -> TextBuilder () Source #

Decimal encoding of an IEEE Double.

Using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

doubleWith Source #

Arguments

:: FFormat
-> Maybe Int	Number of decimal places to render.
-> Double
-> TextBuilder ()

Format double-precision float using drisu3 with dragon4 fallback.

float :: Float -> TextBuilder () Source #

Decimal encoding of an IEEE Float.

Using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

floatWith Source #

Arguments

:: FFormat
-> Maybe Int	Number of decimal places to render.
-> Float
-> TextBuilder ()

Format single-precision float using drisu3 with dragon4 fallback.

scientific :: Scientific -> TextBuilder () Source #

A Builder which renders a scientific number to full precision, using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

scientificWith Source #

Arguments

:: FFormat
-> Maybe Int	Number of decimal places to render.
-> Scientific
-> TextBuilder ()

Like scientific but provides rendering options.