| Copyright | (c) Dong Han 2017-2019 |
|---|---|
| License | BSD |
| Maintainer | winterland1989@gmail.com |
| Stability | experimental |
| Portability | non-portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Z.Data.Text.ShowT
Contents
Description
Synopsis
- class ShowT a where
- toTextBuilder :: Int -> a -> TextBuilder ()
- showT :: ShowT a => a -> Text
- toBuilder :: ShowT a => a -> Builder ()
- toBytes :: ShowT a => a -> Bytes
- toString :: ShowT a => a -> String
- data TextBuilder a
- getBuilder :: TextBuilder a -> Builder a
- unsafeFromBuilder :: Builder a -> TextBuilder a
- buildText :: TextBuilder a -> Text
- stringUTF8 :: String -> TextBuilder ()
- charUTF8 :: Char -> TextBuilder ()
- string7 :: String -> TextBuilder ()
- char7 :: Char -> TextBuilder ()
- text :: Text -> TextBuilder ()
- escapeTextJSON :: Text -> Builder ()
- data IFormat = IFormat {}
- defaultIFormat :: IFormat
- data Padding
- 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
- 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 ()
- paren :: TextBuilder () -> TextBuilder ()
- parenWhen :: Bool -> TextBuilder () -> TextBuilder ()
- curly :: TextBuilder () -> TextBuilder ()
- square :: TextBuilder () -> TextBuilder ()
- angle :: TextBuilder () -> TextBuilder ()
- quotes :: TextBuilder () -> TextBuilder ()
- squotes :: TextBuilder () -> TextBuilder ()
- colon :: TextBuilder ()
- comma :: TextBuilder ()
- intercalateVec :: Vec v a => TextBuilder () -> (a -> TextBuilder ()) -> v a -> TextBuilder ()
- intercalateList :: TextBuilder () -> (a -> TextBuilder ()) -> [a] -> TextBuilder ()
ShowT class
A class similar to Show, serving the purpose that quickly convert a data type to a Text value.
You can use newtype or generic deriving to implement instance of this class quickly:
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DerivingStrategies #-}
import GHC.Generics
newtype FooInt = FooInt Int deriving (Generic)
deriving anyclass ShowT
> showT (FooInt 3)
> "FooInt 3"
newtype FooInt = FooInt Int deriving (Generic)
deriving newtype ShowT
> showT (FooInt 3)
> "3"
Minimal complete definition
Nothing
Methods
toTextBuilder :: Int -> a -> TextBuilder () Source #
toTextBuilder :: (Generic a, GToText (Rep a)) => Int -> a -> TextBuilder () Source #
Instances
Textual Builder
data 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, there's a rewrite rule to
turn encoding loop into a memcpy, which is much faster (the same rule also apply to stringUTF8).
Different from Builder (), TextBuilder ()'s IsString instance will give you desired UTF8 guarantees:
NULwill be written directly asx00.xD800~xDFFFwill be replaced by replacement char.
Instances
getBuilder :: TextBuilder a -> Builder a Source #
unsafeFromBuilder :: Builder a -> TextBuilder a Source #
Unsafely turn a Builder into TextBuilder, thus it's user's responsibility to
ensure only UTF-8 complied bytes are written.
buildText :: TextBuilder a -> Text Source #
Build a Text using TextBuilder, which provide UTF-8 encoding guarantee.
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 #
escapeTextJSON :: Text -> Builder () Source #
Escape text using JSON string escaping rules and add double quotes, escaping rules:
'\b': "\b" '\f': "\f" '\n': "\n" '\r': "\r" '\t': "\t" '"': "\"" '\': "\\" '/': "\/" other chars <= 0x1F: "\u00XX"
Numeric builders
Integral type formatting
Integral formatting options.
Constructors
| IFormat | |
defaultIFormat :: IFormat Source #
defaultIFormat = IFormat 0 NoPadding False
Constructors
| NoPadding | |
| RightSpacePadding | |
| LeftSpacePadding | |
| ZeroPadding |
Instances
| Enum Padding Source # | |
| Eq Padding Source # | |
| Ord Padding Source # | |
Defined in Z.Data.Builder.Numeric | |
| Show Padding Source # | |
| Arbitrary Padding Source # | |
| CoArbitrary Padding Source # | |
Defined in Z.Data.Builder.Numeric Methods coarbitrary :: Padding -> Gen b -> Gen b # | |
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
Control the rendering of floating point numbers.
Constructors
| Exponent | Scientific notation (e.g. |
| Fixed | Standard decimal notation. |
| Generic | Use decimal notation for values between |
Instances
| Enum FFormat Source # | |
| Read FFormat Source # | |
| Show FFormat Source # | |
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.
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.
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.
Arguments
| :: FFormat | |
| -> Maybe Int | Number of decimal places to render. |
| -> Scientific | |
| -> TextBuilder () |
Like scientific but provides rendering options.
Builder helpers
paren :: TextBuilder () -> TextBuilder () Source #
add (...) to original builder.
parenWhen :: Bool -> TextBuilder () -> TextBuilder () Source #
Add "(..)" around builders when condition is met, otherwise add nothing.
This is useful when defining ShowT instances.
curly :: TextBuilder () -> TextBuilder () Source #
add {...} to original builder.
square :: TextBuilder () -> TextBuilder () Source #
add [...] to original builder.
angle :: TextBuilder () -> TextBuilder () Source #
add ... to original builder.
quotes :: TextBuilder () -> TextBuilder () Source #
add "..." to original builder.
squotes :: TextBuilder () -> TextBuilder () Source #
add ...
colon :: TextBuilder () Source #
write an ASCII :
comma :: TextBuilder () Source #
write an ASCII ,
Arguments
| :: Vec v a | |
| => TextBuilder () | the seperator |
| -> (a -> TextBuilder ()) | value formatter |
| -> v a | value list |
| -> TextBuilder () |
Use separator to connect a vector of builders.
Arguments
| :: TextBuilder () | the seperator |
| -> (a -> TextBuilder ()) | value formatter |
| -> [a] | value vector |
| -> TextBuilder () |
Use separator to connect a list of builders.