8f9b765 · text · git.iko.soy

git.iko.soy/text

on master help sign in

Add `@since 1.1.0.0` annotations

8f9b765Herbert Valerio Riedel9 years ago

Data/Text/Encoding.hs+4

compare with master

unifiedsplit

@@ -318,6 +318,8 @@ decodeUtf8' = unsafeDupablePerformIO . try . evaluate . decodeUtf8With strictDec

318{-# INLINE decodeUtf8' #-}

319

320-- | Encode text to a ByteString 'B.Builder' using UTF-8 encoding.

321+--

322+-- @since 1.1.0.0

321encodeUtf8Builder :: Text -> B.Builder

323encodeUtf8Builder :: Text -> B.Builder

322encodeUtf8Builder = encodeUtf8BuilderEscaped (BP.liftFixedToBounded BP.word8)

324encodeUtf8Builder = encodeUtf8BuilderEscaped (BP.liftFixedToBounded BP.word8)

323

325

@@ -326,6 +328,8 @@ encodeUtf8Builder = encodeUtf8BuilderEscaped (BP.liftFixedToBounded BP.word8)

326--

328--

327-- Use this function is to implement efficient encoders for text-based formats

329-- Use this function is to implement efficient encoders for text-based formats

328-- like JSON or HTML.

330-- like JSON or HTML.

331+--

332+-- @since 1.1.0.0

329{-# INLINE encodeUtf8BuilderEscaped #-}

333{-# INLINE encodeUtf8BuilderEscaped #-}

330-- TODO: Extend documentation with references to source code in @blaze-html@

334-- TODO: Extend documentation with references to source code in @blaze-html@

331-- or @aeson@ that uses this function.

335-- or @aeson@ that uses this function.

Data/Text/Lazy/Encoding.hs+11

@@ -141,6 +141,7 @@ decodeUtf8' bs = unsafeDupablePerformIO $ do

141 rnf (Chunk _ ts) = rnf ts

142{-# INLINE decodeUtf8' #-}

143

144+-- | Encode text using UTF-8 encoding.

144encodeUtf8 :: Text -> B.ByteString

145encodeUtf8 :: Text -> B.ByteString

145encodeUtf8 Empty = B.empty

146encodeUtf8 Empty = B.empty

146encodeUtf8 lt@(Chunk t _) =

147encodeUtf8 lt@(Chunk t _) =

@@ -154,10 +155,20 @@ encodeUtf8 lt@(Chunk t _) =

154 firstChunkSize = min B.smallChunkSize (4 * (T.length t + 1))

155 firstChunkSize = min B.smallChunkSize (4 * (T.length t + 1))

155 strategy = B.safeStrategy firstChunkSize B.defaultChunkSize

156 strategy = B.safeStrategy firstChunkSize B.defaultChunkSize

156

157

158+-- | Encode text to a ByteString 'B.Builder' using UTF-8 encoding.

159+--

160+-- @since 1.1.0.0

157encodeUtf8Builder :: Text -> B.Builder

161encodeUtf8Builder :: Text -> B.Builder

158encodeUtf8Builder =

162encodeUtf8Builder =

159 foldrChunks (\c b -> TE.encodeUtf8Builder c `mappend` b) Data.Monoid.mempty

163 foldrChunks (\c b -> TE.encodeUtf8Builder c `mappend` b) Data.Monoid.mempty

160

164

165+-- | Encode text using UTF-8 encoding and escape the ASCII characters using

166+-- a 'BP.BoundedPrim'.

167+--

168+-- Use this function is to implement efficient encoders for text-based formats

169+-- like JSON or HTML.

170+--

171+-- @since 1.1.0.0

161{-# INLINE encodeUtf8BuilderEscaped #-}

172{-# INLINE encodeUtf8BuilderEscaped #-}

162encodeUtf8BuilderEscaped :: BP.BoundedPrim Word8 -> Text -> B.Builder

173encodeUtf8BuilderEscaped :: BP.BoundedPrim Word8 -> Text -> B.Builder

163encodeUtf8BuilderEscaped prim =

174encodeUtf8BuilderEscaped prim =