| License | BSD-style |
|---|---|
| Maintainer | Vincent Hanquez <vincent@snarc.org> |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Foundation.Primitive
Description
- class Eq ty => PrimType ty where
- class (Functor m, Applicative m, Monad m) => PrimMonad m where
- class ByteSwap a
- newtype LE a :: * -> * = LE {
- unLE :: a
- toLE :: ByteSwap a => a -> LE a
- fromLE :: ByteSwap a => LE a -> a
- newtype BE a :: * -> * = BE {
- unBE :: a
- toBE :: ByteSwap a => a -> BE a
- fromBE :: ByteSwap a => BE a -> a
- class IntegralUpsize a b where
- class IntegralDownsize a b where
- class IntegralCast a b where
- class NormalForm a where
- force :: NormalForm a => a -> a
- deepseq :: NormalForm a => a -> b -> b
- data These a b :: * -> * -> *
- data Block ty :: * -> *
- data MutableBlock ty st :: * -> * -> *
- data Char7 :: *
- newtype AsciiString :: * = AsciiString {}
Documentation
class Eq ty => PrimType ty where #
Represent the accessor for types that can be stored in the UArray and MUArray.
Types need to be a instance of storable and have fixed sized.
Minimal complete definition
primSizeInBytes, primShiftToBytes, primBaUIndex, primMbaURead, primMbaUWrite, primAddrIndex, primAddrRead, primAddrWrite
Methods
primSizeInBytes :: Proxy * ty -> CountOf Word8 #
get the size in bytes of a ty element
primShiftToBytes :: Proxy * ty -> Int #
get the shift size
primBaUIndex :: ByteArray# -> Offset ty -> ty #
return the element stored at a specific index
primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset ty -> prim ty #
Read an element at an index in a mutable array
primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset ty -> ty -> prim () #
Write an element to a specific cell in a mutable array.
primAddrIndex :: Addr# -> Offset ty -> ty #
Read from Address, without a state. the value read should be considered a constant for all pratical purpose, otherwise bad thing will happens.
primAddrRead :: PrimMonad prim => Addr# -> Offset ty -> prim ty #
Read a value from Addr in a specific primitive monad
primAddrWrite :: PrimMonad prim => Addr# -> Offset ty -> ty -> prim () #
Write a value to Addr in a specific primitive monad
Instances
class (Functor m, Applicative m, Monad m) => PrimMonad m where #
Primitive monad that can handle mutation.
For example: IO and ST.
Minimal complete definition
primitive, primThrow, unPrimMonad, primVarNew, primVarRead, primVarWrite
Associated Types
type PrimState (m :: * -> *) :: * #
type of state token associated with the PrimMonad m
type PrimVar (m :: * -> *) :: * -> * #
type of variable associated with the PrimMonad m
Methods
primitive :: (State# (PrimState m) -> (#VoidRep, PtrRepLifted, State# (PrimState m), a#)) -> m a #
Unwrap the State# token to pass to a function a primitive function that returns an unboxed state and a value.
primThrow :: Exception e => e -> m a #
Throw Exception in the primitive monad
unPrimMonad :: m a -> State# (PrimState m) -> (#VoidRep, PtrRepLifted, State# (PrimState m), a#) #
Run a Prim monad from a dedicated state#
primVarNew :: a -> m (PrimVar m a) #
Build a new variable in the Prim Monad
primVarRead :: PrimVar m a -> m a #
Read the variable in the Prim Monad
primVarWrite :: PrimVar m a -> a -> m () #
Write the variable in the Prim Monad
endianess
Class of types that can be byte-swapped.
e.g. Word16, Word32, Word64
Minimal complete definition
byteSwap
Little Endian value
Instances
| Eq a => Eq (LE a) | |
| (ByteSwap a, Ord a) => Ord (LE a) | |
| Show a => Show (LE a) | |
| Bits a => Bits (LE a) | |
| PrimType a => PrimType (LE a) | |
| PrimMemoryComparable a => PrimMemoryComparable (LE a) | |
| NormalForm a => NormalForm (LE a) | |
| StorableFixed (LE Word16) # | |
| StorableFixed (LE Word32) # | |
| StorableFixed (LE Word64) # | |
| StorableFixed (LE Word256) # | |
| StorableFixed (LE Word128) # | |
| Storable (LE Word16) # | |
| Storable (LE Word32) # | |
| Storable (LE Word64) # | |
| Storable (LE Word256) # | |
| Storable (LE Word128) # | |
Big Endian value
Instances
| Eq a => Eq (BE a) | |
| (ByteSwap a, Ord a) => Ord (BE a) | |
| Show a => Show (BE a) | |
| Bits a => Bits (BE a) | |
| PrimType a => PrimType (BE a) | |
| PrimMemoryComparable a => PrimMemoryComparable (BE a) | |
| NormalForm a => NormalForm (BE a) | |
| StorableFixed (BE Word16) # | |
| StorableFixed (BE Word32) # | |
| StorableFixed (BE Word64) # | |
| StorableFixed (BE Word256) # | |
| StorableFixed (BE Word128) # | |
| Storable (BE Word16) # | |
| Storable (BE Word32) # | |
| Storable (BE Word64) # | |
| Storable (BE Word256) # | |
| Storable (BE Word128) # | |
Integral convertion
class IntegralUpsize a b where #
Upsize an integral value
The destination type b size need to be greater or equal
than the size type of a
Minimal complete definition
Methods
integralUpsize :: a -> b #
Instances
class IntegralDownsize a b where #
Downsize an integral value
Minimal complete definition
Instances
class IntegralCast a b where #
Cast an integral value to another value that have the same representional size
Methods
integralCast :: a -> b #
Instances
Evaluation
class NormalForm a where #
Data that can be fully evaluated in Normal Form
Minimal complete definition
Methods
toNormalForm :: a -> () #
Instances
force :: NormalForm a => a -> a #
deepseq :: NormalForm a => a -> b -> b #
These
Block of memory
A block of memory containing unpacked bytes representing values of type ty
Instances
| PrimType ty => IsList (Block ty) | |
| (PrimType ty, Eq ty) => Eq (Block ty) | |
| Data ty => Data (Block ty) | |
| (PrimType ty, Ord ty) => Ord (Block ty) | |
| (PrimType ty, Show ty) => Show (Block ty) | |
| PrimType ty => Monoid (Block ty) | |
| NormalForm (Block ty) | |
| PrimType ty => Fold1able (Block ty) # | |
| PrimType ty => Foldable (Block ty) # | |
| PrimType ty => IndexedCollection (Block ty) # | |
| PrimType ty => Copy (Block ty) # | |
| PrimType ty => Collection (Block ty) # | |
| PrimType ty => Sequential (Block ty) # | |
| type Item (Block ty) | |
| type Element (Block ty) # | |
data MutableBlock ty st :: * -> * -> * #
A Mutable block of memory containing unpacked bytes representing values of type ty
Instances
| PrimType ty => MutableCollection (MutableBlock ty) # | |
| type MutableFreezed (MutableBlock ty) # | |
| type MutableKey (MutableBlock ty) # | |
| type MutableValue (MutableBlock ty) # | |
Ascii
ASCII value between 0x0 and 0x7f
newtype AsciiString :: * #
Opaque packed array of characters in the ASCII encoding
Constructors
| AsciiString | |