RingBuffers.Lifted

A concurrent, mutable ring buffer that supports atomic updates. This module supports buffers containing all lifted types. If you are using a buffer which contains some unboxable or unliftable type, consider using Unboxed or Unlifted.

Documentation

data RingBuffer a

A concurrent, mutable ring buffer that supports atomic updates.

new

Arguments

:: Int

capacity of buffer

-> IO (RingBuffer a)

Return a new ring buffer of the specified size.

clear

Arguments

:: RingBuffer a

buffer to clear

-> IO ()

Reset the buffer to its empty state.

append :: a -> RingBuffer a -> IO ()

Add an item to the end of the buffer.

extend :: Array a -> RingBuffer a -> IO ()

Write multiple items to the end of the ring.

Ignores any elements of the input array whose indices are higher than the length of the ring buffer.

capacity :: RingBuffer a -> IO Int

Get the maximum number of items the ring can contain

filledLength :: RingBuffer a -> IO Int

Get the current filled length of the ring

latest :: RingBuffer a -> Int -> IO (Maybe a)

Retrieve the \(n\)th most-recently added item of the ring

unsafeLatest :: RingBuffer a -> Int -> IO a

Retrieve the \(n\)th most-recently added item of the ring

Note: This function may exhibit undefined behaviour if the index is out-of-bounds or uninitialised.

foldMap :: Monoid b => RingBuffer a -> (a -> IO b) -> IO b

Execute the given action with the items of the ring, accumulating its results.

toList :: RingBuffer a -> IO [a]

Convert the entire contents of the ring into a list, with the most recently added element at the head.