Data.Encoding.Bottom

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

Documentation

data Bottom

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

Instances

Eq Bottom

Defined in Data.Encoding.Bottom

Methods

(==) :: Bottom -> Bottom -> Bool

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

Ord Bottom

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

Defined in Data.Encoding.Bottom

Methods

showsPrec :: Int -> Bottom -> ShowS

show :: Bottom -> String

showList :: [Bottom] -> ShowS

Semigroup Bottom

Defined in Data.Encoding.Bottom

Methods

(<>) :: Bottom -> Bottom -> Bottom

sconcat :: NonEmpty Bottom -> Bottom

stimes :: Integral b => b -> Bottom -> Bottom

Monoid Bottom

Defined in Data.Encoding.Bottom

Methods

mempty :: Bottom

mappend :: Bottom -> Bottom -> Bottom

mconcat :: [Bottom] -> Bottom

NFData Bottom

Defined in Data.Encoding.Bottom

Methods

rnf :: Bottom -> ()

unBottom :: Bottom -> ByteString

unBottom unwraps the underlying ByteString.

encode :: Text -> Bottom

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

decode :: Bottom -> Text

decode decodes a Bottom into its corresponding Unicode Text.

decode' :: ByteString -> Either String Text

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