Copyright	(c) 2021 Composewell Technologies
License	BSD-3-Clause
Maintainer	streamly@composewell.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Streamly.Internal.Data.Ring

Contents

Generation
Modification
Conversion

Description

Synopsis

data Ring a = Ring {
- ringArr :: MutArray a
- ringHead :: !Int
- ringMax :: !Int
}
createRing :: MonadIO m => Int -> m (Ring a)
writeLastN :: MonadIO m => Int -> Fold m a (Ring a)
seek :: MonadIO m => Int -> Ring a -> m (Ring a)
unsafeInsertRingWith :: Ring a -> a -> IO Int
toMutArray :: MonadIO m => Int -> Int -> Ring a -> m (MutArray a)
toStreamWith :: Int -> Ring a -> Stream m a

Documentation

data Ring a Source #

Constructors

Ring
Fields ringArr :: MutArray a ringHead :: !Int ringMax :: !Int

Generation

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

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

Modification

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

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

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

Conversion

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

toMutArray rignHeadAdjustment lengthToRead ring. Convert the ring into a boxed mutable array. Note that the returned MutArray may share the same underlying memory as the Ring.

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

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