git.iko.soy/streamly
on master help sign in
Fix since annotations in Array.Foreign module

Module was moved from Streamly.Memory.Array, so the APIs should be marked since the current release.

commit3706e838bea4c48345769db81e76e737ad14ae5c authorHarendra Kumar <harendra@composewell.com> dateThu 3 Jun 2021, 00:18 (5 years ago) parent8b07153
2 files changed+21−7
compare with master
unifiedsplit
src/Streamly/Internal/Data/Array/Foreign.hs+3−1 src/Streamly/Internal/Data/Array/Foreign/Type.hs+18−6
src/Streamly/Internal/Data/Array/Foreign.hs+3−1
@@ -219,7 +219,9 @@ fromStream = P.fold A.write
219219
220220-- | Unfold an array into a stream.
221221--
222−-- @since 0.7.0
222+-- /Since 0.7.0 (Streamly.Memory.Array)/
223+--
224+-- @since 0.8.0
223225{-# INLINE_NORMAL read #-}
224226read :: forall m a. (Monad m, Storable a) => Unfold m (Array a) a
225227read = Unfold.lmap A.unsafeThaw MA.read
src/Streamly/Internal/Data/Array/Foreign/Type.hs+18−6
@@ -294,14 +294,18 @@ fromCString# addr# = do
294294-- allocated to size N, if the list terminates before N elements then the
295295-- array may hold less than N elements.
296296--
297−-- @since 0.7.0
297+-- /Since 0.7.0 (Streamly.Memory.Array)/
298+--
299+-- @since 0.8.0
298300{-# INLINABLE fromListN #-}
299301fromListN :: Storable a => Int -> [a] -> Array a
300302fromListN n xs = unsafeFreeze $ MA.fromListN n xs
301303
302304-- | Create an 'Array' from a list. The list must be of finite size.
303305--
304−-- @since 0.7.0
306+-- /Since 0.7.0 (Streamly.Memory.Array)/
307+--
308+-- @since 0.8.0
305309{-# INLINABLE fromList #-}
306310fromList :: Storable a => [a] -> Array a
307311fromList xs = unsafeFreeze $ MA.fromList xs
@@ -388,7 +392,9 @@ byteLength = MA.byteLength . unsafeThaw
388392-- | /O(1)/ Get the length of the array i.e. the number of elements in the
389393-- array.
390394--
391−-- @since 0.7.0
395+-- /Since 0.7.0 (Streamly.Memory.Array)/
396+--
397+-- @since 0.8.0
392398{-# INLINE length #-}
393399length :: forall a. Storable a => Array a -> Int
394400length arr = MA.length (unsafeThaw arr)
@@ -456,7 +462,9 @@ splitAt i arr = (unsafeFreeze a, unsafeFreeze b)
456462
457463-- | Convert an 'Array' into a list.
458464--
459−-- @since 0.7.0
465+-- /Since 0.7.0 (Streamly.Memory.Array)/
466+--
467+-- @since 0.8.0
460468{-# INLINE toList #-}
461469toList :: Storable a => Array a -> [a]
462470toList = MA.toList . unsafeThaw
@@ -468,7 +476,9 @@ toList = MA.toList . unsafeThaw
468476-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
469477-- 'Array'.
470478--
471−-- @since 0.7.0
479+-- /Since 0.7.0 (Streamly.Memory.Array)/
480+--
481+-- @since 0.8.0
472482{-# INLINE_NORMAL writeN #-}
473483writeN :: forall m a. (MonadIO m, Storable a) => Int -> Fold m a (Array a)
474484writeN = fmap unsafeFreeze . MA.writeN
@@ -531,7 +541,9 @@ toArrayMinChunk alignSize elemCount =
531541--
532542-- /Caution! Do not use this on infinite streams./
533543--
534−-- @since 0.7.0
544+-- /Since 0.7.0 (Streamly.Memory.Array)/
545+--
546+-- @since 0.8.0
535547{-# INLINE write #-}
536548write :: forall m a. (MonadIO m, Storable a) => Fold m a (Array a)
537549write = fmap unsafeFreeze MA.write