Expose decodeUtf8Chunks

Rename decodeUtf8Arrays* to decodeUtf8Chunks* to make it consistent with
other chunked stream operation names.

benchmark/Streamly/Benchmark/Data/Array/Stream.hs

@@ -123,7 +123,7 @@ inspect $ 'toChunksCountBytes `hasNoType` ''Step
 
 toChunksDecodeUtf8Arrays :: Handle -> IO ()
 toChunksDecodeUtf8Arrays =
-   Stream.drain . Unicode.decodeUtf8Arrays . Handle.readChunks
+   Stream.drain . Unicode.decodeUtf8Chunks . Handle.readChunks
 
 #ifdef INSPECTION
 inspect $ hasNoTypeClasses 'toChunksDecodeUtf8Arrays

benchmark/Streamly/Benchmark/Unicode/Stream.hs

@@ -56,7 +56,7 @@ copyCodecUtf8ArraysLenient :: Handle -> Handle -> IO ()
 copyCodecUtf8ArraysLenient inh outh =
    Stream.fold (Handle.write outh)
      $ Unicode.encodeUtf8'
-     $ Unicode.decodeUtf8Arrays
+     $ Unicode.decodeUtf8Chunks
      $ Handle.readChunks inh
 
 #ifdef INSPECTION

core/src/Streamly/Internal/Unicode/Stream.hs

@@ -30,9 +30,9 @@ module Streamly.Internal.Unicode.Stream
     , resumeDecodeUtf8Either
 
     -- ** UTF-8 Array Stream Decoding
-    , decodeUtf8Arrays
-    , decodeUtf8Arrays'
-    , decodeUtf8Arrays_
+    , decodeUtf8Chunks
+    , decodeUtf8Chunks'
+    , decodeUtf8Chunks_
 
     -- * Elimination (Encoding)
     -- ** Latin1 Encoding
@@ -68,9 +68,6 @@ module Streamly.Internal.Unicode.Stream
     , encodeUtf8D_
     , decodeUtf8EitherD
     , resumeDecodeUtf8EitherD
-    , decodeUtf8ArraysD
-    , decodeUtf8ArraysD'
-    , decodeUtf8ArraysD_
 
     -- * Decoding String Literals
     , fromStr#
@@ -804,48 +801,32 @@ decodeUtf8ArraysWithD cfm (D.Stream step state) =
     step' _ _ (YAndC c s) = return $ Yield c s
     step' _ _ D = return Stop
 
-{-# INLINE decodeUtf8ArraysD #-}
-decodeUtf8ArraysD ::
+-- | Like 'decodeUtf8' but for a chunked stream. It may be slightly faster than
+-- flattening the stream and then decoding with 'decodeUtf8'.
+{-# INLINE decodeUtf8Chunks #-}
+decodeUtf8Chunks ::
        MonadIO m
     => D.Stream m (Array Word8)
     -> D.Stream m Char
-decodeUtf8ArraysD = decodeUtf8ArraysWithD TransliterateCodingFailure
+decodeUtf8Chunks = decodeUtf8ArraysWithD TransliterateCodingFailure
 
--- |
---
--- /Pre-release/
-{-# INLINE decodeUtf8Arrays #-}
-decodeUtf8Arrays :: MonadIO m => Stream m (Array Word8) -> Stream m Char
-decodeUtf8Arrays = decodeUtf8ArraysD
-
-{-# INLINE decodeUtf8ArraysD' #-}
-decodeUtf8ArraysD' ::
+-- | Like 'decodeUtf8\'' but for a chunked stream. It may be slightly faster
+-- than flattening the stream and then decoding with 'decodeUtf8\''.
+{-# INLINE decodeUtf8Chunks' #-}
+decodeUtf8Chunks' ::
        MonadIO m
     => D.Stream m (Array Word8)
     -> D.Stream m Char
-decodeUtf8ArraysD' = decodeUtf8ArraysWithD ErrorOnCodingFailure
+decodeUtf8Chunks' = decodeUtf8ArraysWithD ErrorOnCodingFailure
 
--- |
---
--- /Pre-release/
-{-# INLINE decodeUtf8Arrays' #-}
-decodeUtf8Arrays' :: MonadIO m => Stream m (Array Word8) -> Stream m Char
-decodeUtf8Arrays' = decodeUtf8ArraysD'
-
-{-# INLINE decodeUtf8ArraysD_ #-}
-decodeUtf8ArraysD_ ::
+-- | Like 'decodeUtf8_' but for a chunked stream. It may be slightly faster
+-- than flattening the stream and then decoding with 'decodeUtf8_'.
+{-# INLINE decodeUtf8Chunks_ #-}
+decodeUtf8Chunks_ ::
        MonadIO m
     => D.Stream m (Array Word8)
     -> D.Stream m Char
-decodeUtf8ArraysD_ = decodeUtf8ArraysWithD DropOnCodingFailure
-
--- |
---
--- /Pre-release/
-{-# INLINE decodeUtf8Arrays_ #-}
-decodeUtf8Arrays_ ::
-       MonadIO m => Stream m (Array Word8) -> Stream m Char
-decodeUtf8Arrays_ = decodeUtf8ArraysD_
+decodeUtf8Chunks_ = decodeUtf8ArraysWithD DropOnCodingFailure
 
 -------------------------------------------------------------------------------
 -- Encoding Unicode (UTF-8) Characters

core/src/Streamly/Unicode/Stream.hs

@@ -79,6 +79,7 @@ module Streamly.Unicode.Stream
       decodeLatin1
     , decodeUtf8
     , decodeUtf8'
+    , decodeUtf8Chunks
 
     -- * Elimination (Encoding)
     , encodeLatin1

test/Streamly/Test/Unicode/Stream.hs

@@ -68,7 +68,7 @@ propDecodeEncodeIdArrays =
     forAll genUnicode $ \list ->
         monadicIO $ do
             let wrds = Stream.arraysOf 8 $ SS.encodeUtf8' $ Stream.fromList list
-            chrs <- Stream.toList $ IUS.decodeUtf8Arrays wrds
+            chrs <- Stream.toList $ IUS.decodeUtf8Chunks wrds
             assert (chrs == list)
 
 unicodeTestData :: [Char]