Flat.Instances.Text

Flat instances for the text library

Documentation

newtype UTF8Text

The desired text encoding can be explicitly specified using the wrappers UTF8Text and UTF16Text.

The default encoding is UTF8:

>>> tst (UTF8Text $ T.pack "日日日") == tst (T.pack "日日日")
True

A wrapper to encode/decode Text as UTF8 (slower but more compact)

Constructors

UTF8Text

Fields

• unUTF8 :: Text

Instances

Eq UTF8Text

Defined in Flat.Instances.Text

Methods

(==) :: UTF8Text -> UTF8Text -> Bool

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

Ord UTF8Text

Defined in Flat.Instances.Text

Methods

compare :: UTF8Text -> UTF8Text -> Ordering

(<) :: UTF8Text -> UTF8Text -> Bool

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

(>) :: UTF8Text -> UTF8Text -> Bool

(>=) :: UTF8Text -> UTF8Text -> Bool

max :: UTF8Text -> UTF8Text -> UTF8Text

min :: UTF8Text -> UTF8Text -> UTF8Text

Show UTF8Text

Defined in Flat.Instances.Text

Methods

showsPrec :: Int -> UTF8Text -> ShowS

show :: UTF8Text -> String

showList :: [UTF8Text] -> ShowS

Flat UTF8Text

Defined in Flat.Instances.Text

Methods

encode :: UTF8Text -> Encoding

decode :: Get UTF8Text

size :: UTF8Text -> NumBits -> NumBits

newtype UTF16Text

>>> tst (UTF16Text $ T.pack "aaa")
(True,72,[1,6,97,0,97,0,97,0,0])

>>> tst (UTF16Text $ T.pack "𐍈𐍈𐍈")
(True,120,[1,12,0,216,72,223,0,216,72,223,0,216,72,223,0])

A wrapper to encode/decode Text as UTF16 (faster but bigger)

Constructors

UTF16Text

Fields

• unUTF16 :: Text

Instances

Eq UTF16Text

Defined in Flat.Instances.Text

Methods

(==) :: UTF16Text -> UTF16Text -> Bool

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

Ord UTF16Text

Defined in Flat.Instances.Text

Methods

compare :: UTF16Text -> UTF16Text -> Ordering

(<) :: UTF16Text -> UTF16Text -> Bool

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

(>) :: UTF16Text -> UTF16Text -> Bool

(>=) :: UTF16Text -> UTF16Text -> Bool

max :: UTF16Text -> UTF16Text -> UTF16Text

min :: UTF16Text -> UTF16Text -> UTF16Text

Show UTF16Text

Defined in Flat.Instances.Text

Methods

showsPrec :: Int -> UTF16Text -> ShowS

show :: UTF16Text -> String

showList :: [UTF16Text] -> ShowS

Flat UTF16Text

Defined in Flat.Instances.Text

Methods

encode :: UTF16Text -> Encoding

decode :: Get UTF16Text

size :: UTF16Text -> NumBits -> NumBits

Orphan instances

Flat Text

Methods

encode :: Text -> Encoding

decode :: Get Text

size :: Text -> NumBits -> NumBits

Flat Text

Text (and Data.Text.Lazy) is encoded as a byte aligned array of bytes corresponding to its UTF8 encoding.

>>> tst $ T.pack ""
(True,16,[1,0])

>>> tst $ T.pack "aaa"
(True,120,[1,3,97,97,97,0])

>>> tst $ T.pack "¢¢¢"
(True,120,[1,6,194,162,194,162,194,162,0])

>>> tst $ T.pack "日日日"
(True,120,[1,9,230,151,165,230,151,165,230,151,165,0])

>>> tst $ T.pack "𐍈𐍈𐍈"
(True,120,[1,12,240,144,141,136,240,144,141,136,240,144,141,136,0])

Strict and Lazy Text has the same encoding:

>>> tst (T.pack "abc") == tst (TL.pack "abc")
True

Methods

encode :: Text -> Encoding

decode :: Get Text

size :: Text -> NumBits -> NumBits