Data.FastWeakBag

This module defines the FastWeakBag type, which represents a mutable collection of items that does not cause the items to be retained in memory. This is useful for situations where a value needs to be inspected or modified if it is still alive, but can be ignored if it is dead.

Documentation

data FastWeakBag a

A FastWeakBag holds a set of values of type a, but does not retain them - that is, they can still be garbage-collected. As long as the a values remain alive, the FastWeakBag will continue to refer to them.

data FastWeakBagTicket a

When inserting an item into a FastWeakBag, a FastWeakBagTicket is returned. If the caller retains the ticket, the item is guranteed to stay in memory (and thus in the FastWeakBag). The ticket can also be used to remove the item from the FastWeakBag prematurely (i.e. while it is still alive), using remove.

empty :: IO (FastWeakBag a)

Create an empty FastWeakBag.

isEmpty :: FastWeakBag a -> IO Bool

Check whether a FastWeakBag is empty.

insert

Arguments

:: a

The item

-> FastWeakBag a

The FastWeakBag to insert into

-> IO (FastWeakBagTicket a)

Returns a FastWeakBagTicket that ensures the item is retained and allows the item to be removed.

Insert an item into a FastWeakBag.

traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()

Deprecated: Use traverse_ instead

traverse_ :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()

Visit every node in the given list. If new nodes are appended during the traversal, they will not be visited. Every live node that was in the list when the traversal began will be visited exactly once; however, no guarantee is made about the order of the traversal.

remove :: FastWeakBagTicket a -> IO ()

Remove an item from the FastWeakBag; does nothing if invoked multiple times on the same FastWeakBagTicket.

Internal functions

_weakBag_children :: FastWeakBag a -> IORef (IntMap (Weak a))

Map of items contained by the FastWeakBag