Modulestreamly-core-0.3.1Haskell2010

Streamly.Internal.Data.RingArray.Generic

Contents

Generation
Modification
Conversion

Synopsis

data RingArray
type Ring
value emptyOf
value createOf
value seek
value unsafeInsertRingWith
value toMutArray
value copyToMutArray
value toStreamWith

Packagestreamly-core-0.3.1
Exports9
LanguageHaskell2010
LicenceBSD-3-Clause
SourceGeneric.hs

datadata RingArray a

Constructors

RingArray
- ringArr :: MutArray a
- ringHead :: !Int
- ringMax :: !Int

typetype Ring = RingArray

Deprecated. Please use RingArray instead.

Generation

valueemptyOf :: MonadIO m => Int -> m (RingArray a)

valuecreateOf :: MonadIO m => Int -> Fold m a (RingArray a)

Source#

Note that it is not safe to return a reference to the mutable RingArray using a scan as the RingArray is continuously getting mutated. You could however copy out the RingArray.

Modification

valueseek :: MonadIO m => Int -> RingArray a -> m (RingArray a)

Source#

Move the ring head clockwise (+ve adj) or counter clockwise (-ve adj) by the given amount.

valueunsafeInsertRingWith :: RingArray a -> a -> IO Int

Conversion

valuetoMutArray :: MonadIO m => Int -> Int -> RingArray a -> m (MutArray a)

Source#

toMutArray rignHeadAdjustment lengthToRead ring. Convert the ring into a boxed mutable array. Note that the returned MutArray shares the same underlying memory as the RingArray, the user of this API needs to ensure that the ring is not mutated during and after the conversion.

valuecopyToMutArray :: MonadIO m => Int -> Int -> RingArray a -> m (MutArray a)

Source#

Copy out the mutable ring to a mutable Array.

valuetoStreamWith :: Int -> RingArray a -> Stream m a

Source#

Seek by n and then read the entire ring. Use take on the stream to restrict the reads.