Safe Haskell	None
Language	Haskell2010

Data.Encoding.Bottom

Description

Encodes and decodes Texts to Bottoms. For details, see the Bottom spec.

Synopsis

Documentation

A Bottom is a wrapper around well-formed, Bottom-encoded ByteString. Its instances are derived from those of ByteString.

Instances details

Eq Bottom Source #
Instance details Defined in Data.Encoding.Bottom Methods (==) :: Bottom -> Bottom -> Bool # (/=) :: Bottom -> Bottom -> Bool #
Ord Bottom Source #
Instance details Defined in Data.Encoding.Bottom Methods compare :: Bottom -> Bottom -> Ordering # (<) :: Bottom -> Bottom -> Bool # (<=) :: Bottom -> Bottom -> Bool # (>) :: Bottom -> Bottom -> Bool # (>=) :: Bottom -> Bottom -> Bool # max :: Bottom -> Bottom -> Bottom # min :: Bottom -> Bottom -> Bottom #
Show Bottom Source #
Instance details Defined in Data.Encoding.Bottom Methods showsPrec :: Int -> Bottom -> ShowS # show :: Bottom -> String # showList :: [Bottom] -> ShowS #
Semigroup Bottom Source #
Instance details Defined in Data.Encoding.Bottom Methods (<>) :: Bottom -> Bottom -> Bottom # sconcat :: NonEmpty Bottom -> Bottom # stimes :: Integral b => b -> Bottom -> Bottom #
Monoid Bottom Source #
Instance details Defined in Data.Encoding.Bottom Methods mempty :: Bottom # mappend :: Bottom -> Bottom -> Bottom # mconcat :: [Bottom] -> Bottom #
NFData Bottom Source #
Instance details Defined in Data.Encoding.Bottom Methods rnf :: Bottom -> () #

unBottom unwraps the underlying ByteString.

encode takes a Text, and encodes it into a Bottom. To get at the underlying ByteString, unwrap the returned value with unBottom.

decode decodes a Bottom into its corresponding Unicode Text.

decode' decodes an arbitrary Bottom-encoded ByteString into a Text, or returns a parse error if the ByteString is malformed.