:: a typeCtrl KGHC 9.14.1 · lts/ghc-9.14.x · d82dee8 · 2026-10-12
Modulemutable-containers-0.3.4.1Haskell2010
Classes and concrete implementations for mutable data structures.
For more information on the design of this library, see the README file, also available at http://www.stackage.org/package/mutable-containers.
A primitive ByteArray reference, supporting any monad.
Since 0.2.0
MutableContainer (PRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.PRefPrim a => MutableRef (PRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.PReftype MCState (PRef s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.PReftype RefElement (PRef s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.PRefA primitive ByteArray IO reference.
Since 0.2.0
An unboxed vector reference, supporting any monad.
Since 0.2.0
MutableContainer (URef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.URefUnbox a => MutableRef (URef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.UReftype MCState (URef s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.UReftype RefElement (URef s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.URefAn unboxed IO vector reference.
Since 0.2.0
A storable vector reference, supporting any monad.
Since 0.2.0
MutableContainer (SRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.SRefStorable a => MutableRef (SRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.SReftype MCState (SRef s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.SReftype RefElement (SRef s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.SRefA storable IO vector reference.
Since 0.2.0
A boxed vector reference, supporting any monad.
Since 0.2.0
Monoid w => MutableCollection (BRef s w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutableContainer (BRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefIsSequence seq => MutablePopBack (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefIsSequence seq => MutablePopFront (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefIsSequence seq => MutablePushBack (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefIsSequence seq => MutablePushFront (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutableRef (BRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BReftype CollElement (BRef s w) = Element wDefined in mutable-containers-0.3.4.1 · Data.Mutable.BReftype MCState (BRef s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.BReftype RefElement (BRef s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.BRefA boxed IO vector reference.
Since 0.2.0
NFData1 IORefDefined in deepseq-1.5.1.0 · Control.DeepSeqEq (IORef a)Defined in ghc-internal-9.1401.0 · GHC.Internal.IORefPointer equality.
NFData (IORef a)Defined in deepseq-1.5.1.0 · Control.DeepSeqNOTE: Only strict in the reference and not the referenced value.
MutableAtomicRef (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMonoid w => MutableCollection (IORef w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableContainer (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopBack (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopFront (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushBack (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushFront (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableRef (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype CollElement (IORef w) = Element wDefined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype MCState (IORef a) = PrimState IODefined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype RefElement (IORef a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.ClassSince 0.2.0
a value of type STRef s a is a mutable variable in state thread s,
containing a value of type a
:{runST (do ref <- newSTRef "hello" x <- readSTRef ref writeSTRef ref (x ++ "world") readSTRef ref ):}"helloworld"
NFData2 STRefDefined in deepseq-1.5.1.0 · Control.DeepSeqNFData1 (STRef s)Defined in deepseq-1.5.1.0 · Control.DeepSeqEq (STRef s a)Defined in ghc-internal-9.1401.0 · GHC.Internal.STRefPointer equality.
NFData (STRef s a)Defined in deepseq-1.5.1.0 · Control.DeepSeqNOTE: Only strict in the reference and not the referenced value.
Monoid w => MutableCollection (STRef s w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableContainer (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopBack (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopFront (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushBack (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushFront (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableRef (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype CollElement (STRef s w) = Element wDefined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype MCState (STRef s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype RefElement (STRef s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.ClassSince 0.2.0
A MutVar behaves like a single-element mutable array associated with a primitive state token.
Eq (MutVar s a)Defined in primitive-0.9.1.0 · Data.Primitive.MutVarMutableAtomicRef (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMonoid w => MutableCollection (MutVar s w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableContainer (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopBack (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopFront (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushBack (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushFront (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableRef (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype CollElement (MutVar s w) = Element wDefined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype MCState (MutVar s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.Classtype RefElement (MutVar s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.ClassSince 0.2.0
A double-ended queue supporting any underlying vector type and any monad.
This implements a circular double-ended queue with exponential growth.
Since 0.2.0
MVector v a => MutableCollection (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeMutableContainer (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeMVector v a => MutablePopBack (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeMVector v a => MutablePopFront (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeMVector v a => MutablePushBack (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeMVector v a => MutablePushFront (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.Dequetype CollElement (Deque v s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.Dequetype MCState (Deque v s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.DequeA Deque specialized to unboxed vectors.
Since 0.2.0
Since 0.2.0
A Deque specialized to storable vectors.
Since 0.2.0
Since 0.2.0
A Deque specialized to boxed vectors.
Since 0.2.0
Since 0.2.0
A doubly-linked list.
Since 0.3.0
MutableCollection (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMutableContainer (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMutablePopBack (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMutablePopFront (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMutablePushBack (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMutablePushFront (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListtype CollElement (DLList s a) = aDefined in mutable-containers-0.3.4.1 · Data.Mutable.DLListtype MCState (DLList s a) = sDefined in mutable-containers-0.3.4.1 · Data.Mutable.DLListSince 0.2.0
The parent typeclass for all mutable containers.
Since 0.2.0
MutableContainer (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableContainer (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableContainer (BRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutableContainer (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMutableContainer (PRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.PRefMutableContainer (SRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.SRefMutableContainer (URef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.URefMutableContainer (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableContainer (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeTypeclass for single-cell mutable references.
Since 0.2.0
type family RefElement cAssociated type giving the type of the value inside the mutable reference.
Since 0.2.0
newRef :: (PrimMonad m, PrimState m ~ MCState c) => RefElement c -> m cCreate a new mutable reference with the given value.
Since 0.2.0
readRef :: (PrimMonad m, PrimState m ~ MCState c) => c -> m (RefElement c)Read the current value in the mutable reference.
Since 0.2.0
writeRef :: (PrimMonad m, PrimState m ~ MCState c) => c -> RefElement c -> m ()Write a new value to the mutable reference.
Since 0.2.0
modifyRef :: (PrimMonad m, PrimState m ~ MCState c) => c -> (RefElement c -> RefElement c) -> m ()Modify the value in the mutable reference, without necessarily forcing the result.
Note: some implementations will force the result, in particular
PRef, SRef, and URef.
Since 0.2.0
modifyRef' :: (PrimMonad m, PrimState m ~ MCState c) => c -> (RefElement c -> RefElement c) -> m ()Modify the value in the mutable reference, forcing the result.
Since 0.2.0
MutableRef (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassStorable a => MutableRef (SRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.SRefMutableRef (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableRef (BRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutableRef (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassPrim a => MutableRef (PRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.PRefUnbox a => MutableRef (URef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.URefMutableRefs that provide for atomic modifications of their contents.
Since 0.2.0
atomicModifyRef :: (PrimMonad m, PrimState m ~ MCState c) => c -> (RefElement c -> (RefElement c, a)) -> m aModify the value without necessarily forcing the result.
Since 0.2.0
atomicModifyRef' :: (PrimMonad m, PrimState m ~ MCState c) => c -> (RefElement c -> (RefElement c, a)) -> m aModify the value, forcing the result.
Since 0.2.0
MutableAtomicRef (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableAtomicRef (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassContainers which contain 0 or more values.
Since 0.2.0
type family CollElement cThe type of each value in the collection.
Since 0.2.0
Monoid w => MutableCollection (IORef w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMonoid w => MutableCollection (STRef s w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMonoid w => MutableCollection (BRef s w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMonoid w => MutableCollection (MutVar s w)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassMutableCollection (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMVector v a => MutableCollection (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequePlace a value at the front of the collection.
Since 0.2.0
IsSequence a => MutablePushFront (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushFront (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushFront (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence seq => MutablePushFront (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutablePushFront (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMVector v a => MutablePushFront (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequePlace a value at the back of the collection.
Since 0.2.0
IsSequence a => MutablePushBack (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushBack (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePushBack (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence seq => MutablePushBack (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutablePushBack (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMVector v a => MutablePushBack (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeTake a value from the front of the collection, if available.
Since 0.2.0
IsSequence a => MutablePopFront (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopFront (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopFront (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence seq => MutablePopFront (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutablePopFront (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMVector v a => MutablePopFront (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeTake a value from the back of the collection, if available.
Since 0.2.0
IsSequence a => MutablePopBack (IORef a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopBack (STRef s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence a => MutablePopBack (MutVar s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.ClassIsSequence seq => MutablePopBack (BRef s seq)Defined in mutable-containers-0.3.4.1 · Data.Mutable.BRefMutablePopBack (DLList s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DLListMVector v a => MutablePopBack (Deque v s a)Defined in mutable-containers-0.3.4.1 · Data.Mutable.DequeCollections which allow pushing and popping at the front (aka FIFOs).
Since 0.2.0
Collections which allow pushing at the back and popping at the front (aka FILOs).
Since 0.2.0
Collections which allow pushing and popping at the front and back.
Since 0.2.0
Class of monads which can perform primitive state-transformer actions.
PrimMonad IODefined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad (ST s)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad (ST s)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (MaybeT m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (ExceptT e m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (IdentityT m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (ReaderT r m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (SelectT r m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (StateT s m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (StateT s m)Defined in primitive-0.9.1.0 · Control.Monad.Primitive(Monoid w, PrimMonad m) => PrimMonad (AccumT w m)Defined in primitive-0.9.1.0 · Control.Monad.Primitive(Monoid w, PrimMonad m) => PrimMonad (WriterT w m)Defined in primitive-0.9.1.0 · Control.Monad.Primitive(Monoid w, PrimMonad m) => PrimMonad (WriterT w m)Defined in primitive-0.9.1.0 · Control.Monad.Primitive(Monoid w, PrimMonad m) => PrimMonad (WriterT w m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitivePrimMonad m => PrimMonad (ContT r m)Defined in primitive-0.9.1.0 · Control.Monad.Primitive(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m)Defined in primitive-0.9.1.0 · Control.Monad.Primitive(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m)Defined in primitive-0.9.1.0 · Control.Monad.Primitive(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m)Defined in primitive-0.9.1.0 · Control.Monad.PrimitiveState token type.
type PrimState IO = RealWorldDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (ST s) = sDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (ST s) = sDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (AccumT w m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (ContT r m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (ExceptT e m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (IdentityT m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (MaybeT m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (RWST r w s m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (RWST r w s m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (RWST r w s m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (ReaderT r m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (SelectT r m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (StateT s m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (StateT s m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (WriterT w m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (WriterT w m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.Primitivetype PrimState (WriterT w m) = PrimState mDefined in primitive-0.9.1.0 · Control.Monad.PrimitiveRealWorld is deeply magical. It is primitive, but it is not
unlifted (hence ptrArg). We never manipulate values of type
RealWorld; it's only used in the type system, to parameterise State#.
Class of types supporting primitive array operations. This includes
interfacing with GC-managed memory (functions suffixed with ByteArray#)
and interfacing with unmanaged memory (functions suffixed with Addr#).
Endianness is platform-dependent.
Prim CBoolDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CCharDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CClockDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CDoubleDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CFloatDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CIntDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CIntMaxDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CIntPtrDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CLLongDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CLongDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CPtrdiffDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CSCharDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CSUSecondsDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CShortDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CSigAtomicDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CSizeDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CTimeDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CUCharDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CUIntDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CUIntMaxDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CUIntPtrDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CULLongDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CULongDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CUSecondsDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CUShortDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CWcharDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim IntPtrDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim WordPtrDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Int16Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Int32Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Int64Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Int8Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CBlkCntDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CBlkSizeDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CCcDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CClockIdDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CDevDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CFsBlkCntDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CFsFilCntDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CGidDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CIdDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CInoDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CKeyDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CModeDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CNlinkDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim COffDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CPidDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CRLimDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CSpeedDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CSsizeDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CTcflagDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CTimerDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CUidDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim FdDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim CharDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim DoubleDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim FloatDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim IntDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim WordDefined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Word16Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Word32Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Word64Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim Word8Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim (FunPtr a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim (Ptr a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim (StablePtr a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Complex a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (First a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Last a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Max a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Min a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Identity a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Down a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Dual a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Product a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Sum a)Defined in primitive-0.9.1.0 · Data.Primitive.TypesPrim a => Prim (Const a b)Defined in primitive-0.9.1.0 · Data.Primitive.TypesUnbox BitDefined in bitvec-1.1.6.0 · Data.Bit.InternalUnbox BitDefined in bitvec-1.1.6.0 · Data.Bit.InternalTSUnbox AllDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox AnyDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Int16Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Int32Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Int64Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Int8Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox BoolDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox CharDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox DoubleDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox FloatDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox IntDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox WordDefined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Word16Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Word32Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Word64Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox Word8Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox ()Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseNFData a => Unbox (DoNotUnboxNormalForm a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox (DoNotUnboxLazy a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox (DoNotUnboxStrict a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Complex a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (First a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Last a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Max a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Min a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (WrappedMonoid a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Identity a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Down a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Dual a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Product a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Sum a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.Base(Unbox a, Unbox b) => Unbox (Arg a b)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.Base(Unbox a, Unbox b) => Unbox (a, b)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox (f a) => Unbox (Alt f a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox a => Unbox (Const a b)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.Base(Unbox a, Unbox b, Unbox c) => Unbox (a, b, c)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.Base(Unbox a, Unbox b, Unbox c, Unbox d) => Unbox (a, b, c, d)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseUnbox (f (g a)) => Unbox (Compose f g a)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.Base(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => Unbox (a, b, c, d, e)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.Base(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => Unbox (a, b, c, d, e, f)Defined in vector-0.13.2.0 · Data.Vector.Unboxed.BaseThe member functions of this class facilitate writing values of primitive types to raw memory (which may have been allocated with the above mentioned routines) and reading values from blocks of raw memory. The class, furthermore, includes support for computing the storage requirements and alignment restrictions of storable types.
Memory addresses are represented as values of type Ptr a, for some
a which is an instance of class Storable. The type argument to
Ptr helps provide some valuable type safety in FFI code (you can't
mix pointers of different types without an explicit cast), while
helping the Haskell type system figure out which marshalling method is
needed for a given pointer.
All marshalling between Haskell and a foreign language ultimately
boils down to translating Haskell data structures into the binary
representation of a corresponding data structure of the foreign
language and vice versa. To code this marshalling in Haskell, it is
necessary to manipulate primitive data types stored in unstructured
memory blocks. The class Storable facilitates this manipulation on
all types for which it is instantiated, which are the standard basic
types of Haskell, the fixed size Int types (Int8, Int16,
Int32, Int64), the fixed size Word types (Word8, Word16,
Word32, Word64), StablePtr, all types from Foreign.C.Types,
as well as Ptr.
Storable EventDefined in ghc-internal-9.1401.0 · GHC.Internal.Event.EPollStorable EventDefined in ghc-internal-9.1401.0 · GHC.Internal.Event.PollStorable PollFdDefined in ghc-internal-9.1401.0 · GHC.Internal.Event.PollStorable FingerprintDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable CBoolDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CCharDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CClockDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CDoubleDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CFloatDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CIntDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CIntMaxDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CIntPtrDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CLLongDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CLongDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CPtrdiffDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CSCharDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CSUSecondsDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CShortDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CSigAtomicDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CSizeDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CTimeDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CUCharDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CUIntDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CUIntMaxDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CUIntPtrDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CULLongDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CULongDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CUSecondsDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CUShortDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable CWcharDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.C.TypesStorable IntPtrDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.PtrStorable WordPtrDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.PtrStorable HalfWordDefined in ghc-internal-9.1401.0 · GHC.Internal.Heap.InfoTable.TypesStorable FLockDefined in ghc-internal-9.1401.0 · GHC.Internal.IO.Handle.Lock.LinuxOFDStorable Int16Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable Int32Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable Int64Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable Int8Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable CBlkCntDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CBlkSizeDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CCcDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CClockIdDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CDevDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CFsBlkCntDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CFsFilCntDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CGidDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CIdDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CInoDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CKeyDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CModeDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CNfdsDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CNlinkDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable COffDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CPidDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CRLimDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CSocklenDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CSpeedDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CSsizeDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CTcflagDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CTimerDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable CUidDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable FdDefined in ghc-internal-9.1401.0 · GHC.Internal.System.Posix.TypesStorable BoolDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable CharDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable DoubleDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable FloatDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable IntDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable WordDefined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable Word16Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable Word32Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable Word64Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable Word8Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable ()Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable (ConstPtr a)Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable (FunPtr a)Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable (Ptr a)Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable (StablePtr a)Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable a => Storable (Complex a)Defined in base-4.22.0.0 · Data.ComplexStorable a => Storable (Identity a)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Functor.IdentityStorable a => Storable (Down a)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.OrdPrim a => Storable (PrimStorable a)Defined in primitive-0.9.1.0 · Data.Primitive.Types(Storable a, Integral a) => Storable (Ratio a)Defined in ghc-internal-9.1401.0 · GHC.Internal.Foreign.StorableStorable a => Storable (Const a b)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Functor.Const