Streamly.Internal.Data.Ring.Generic

Documentation

data Ring a

Constructors

Ring

Fields

• ringArr :: MutArray a
• ringHead :: !Int
• ringMax :: !Int

Generation

createRing :: MonadIO m => Int -> m (Ring a)

writeLastN :: MonadIO m => Int -> Fold m a (Ring a)

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

Modification

seek :: MonadIO m => Int -> Ring a -> m (Ring a)

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

unsafeInsertRingWith :: Ring a -> a -> IO Int

Conversion

toMutArray :: MonadIO m => Int -> Int -> Ring a -> m (MutArray a)

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

copyToMutArray :: MonadIO m => Int -> Int -> Ring a -> m (MutArray a)

Copy out the mutable ring to a mutable Array.

toStreamWith :: Int -> Ring a -> Stream m a

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