From 8ad2522cda1d5af4ea59fe7386df75974ef19a24 Mon Sep 17 00:00:00 2001 From: Stephen Diehl Date: Sat, 11 Mar 2017 09:59:58 +0000 Subject: [PATCH] add strictness functions documentation --- docs/Strings.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/Strings.md b/docs/Strings.md index 17f86d104..080604f08 100644 --- a/docs/Strings.md +++ b/docs/Strings.md @@ -57,6 +57,29 @@ decodeUtf8' :: ByteString -> Either UnicodeException Text decodeUtf8With :: OnDecodeError -> ByteString -> Text ``` +#### UnicodeException + +```haskell +data UnicodeException + = DecodeError [Char] (Maybe Word8) + | EncodeError [Char] (Maybe Char) +``` + +Strictness +---------- + +#### fromStrict + +```haskell +fromStrict :: Text -> LText +``` + +#### toStrict + +```haskell +toStrict :: LText -> Text +``` + Conversion ---------- @@ -67,10 +90,14 @@ class StringConv a b where data Leniency = Lenient | Strict ``` +#### toS + ```haskell toS :: StringConv a b => a -> b ``` +#### toSL + ```haskell toSL :: StringConv a b => a -> b ```