Modulebasement-0.0.16Haskell2010

Basement.FinalPtr

A smaller ForeignPtr reimplementation that work in any prim monad.

Here be dragon.

1 type
8 values

Packagebasement-0.0.16
Exports9
LanguageHaskell2010
LicenceBSD-3-Clause
SourceFinalPtr.hs

datadata FinalPtr a

Create a pointer with an associated finalizer

Constructors

FinalPtr (Ptr a)
FinalForeign (ForeignPtr a)

Instances3Eq, Ord, Show

Eq (FinalPtr a)Defined in basement-0.0.16 · Basement.FinalPtr
Ord (FinalPtr a)Defined in basement-0.0.16 · Basement.FinalPtr
Show (FinalPtr a)Defined in basement-0.0.16 · Basement.FinalPtr

valuefinalPtrSameMemory :: FinalPtr a -> FinalPtr b -> Bool

Check if 2 final ptr points on the same memory bits

it stand to reason that provided a final ptr that is still being referenced and thus have the memory still valid, if 2 final ptrs have the same address, they should be the same final ptr

valuecastFinalPtr :: FinalPtr a -> FinalPtr b

Cast a finalized pointer from type a to type b

valuetoFinalPtr

:: PrimMonad prim
=> Ptr a
-> Ptr a -> IO ()
-> prim (FinalPtr a)

create a new FinalPtr from a Pointer

valuetoFinalPtrForeign :: ForeignPtr a -> FinalPtr a

Create a new FinalPtr from a ForeignPtr

valuetouchFinalPtr :: PrimMonad prim => FinalPtr p -> prim ()

valuewithFinalPtr :: PrimMonad prim => FinalPtr p -> (Ptr p -> prim a) -> prim a

Looks at the raw pointer inside a FinalPtr, making sure the data pointed by the pointer is not finalized during the call to f

valuewithUnsafeFinalPtr :: PrimMonad prim => FinalPtr p -> (Ptr p -> prim a) -> a

Unsafe version of withFinalPtr

valuewithFinalPtrNoTouch :: FinalPtr p -> (Ptr p -> a) -> a