License	BSD-style
Maintainer	Vincent Hanquez <vincent@snarc.org>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Basement.Compat.Primitive

Description

Synopsis

bool# :: Int# -> Bool
data PinnedStatus
- = Pinned
- | Unpinned
toPinnedStatus# :: Pinned# -> PinnedStatus
compatMkWeak# :: o -> b -> IO () -> State# RealWorld -> (# State# RealWorld, Weak# b #)
compatIsByteArrayPinned# :: ByteArray# -> Pinned#
compatIsMutableByteArrayPinned# :: MutableByteArray# s -> Pinned#
unsafeCoerce# :: forall (k0 :: RuntimeRep) (k1 :: RuntimeRep) (a :: TYPE k0) (b :: TYPE k1). a -> b
data Word = W# Word#
type Word8# = Word#
type Word16# = Word#
type Word32# = Word#
type Int8# = Int#
type Int16# = Int#
type Int32# = Int#
word8ToWord16# :: Word8# -> Word16#
word8ToWord32# :: Word8# -> Word32#
word8ToWord# :: Word8# -> Word#
word16ToWord8# :: Word16# -> Word8#
word16ToWord32# :: Word16# -> Word32#
word16ToWord# :: Word16# -> Word#
word32ToWord# :: Word32# -> Word#
word32ToWord8# :: Word32# -> Word8#
word32ToWord16# :: Word32# -> Word16#
wordToWord32# :: Word# -> Word32#
wordToWord16# :: Word# -> Word16#
wordToWord8# :: Word# -> Word8#
int8ToInt16# :: Int8# -> Int16#
int8ToInt32# :: Int8# -> Int32#
int8ToInt# :: Int8# -> Int#
int16ToInt32# :: Int16# -> Int32#
int16ToInt# :: Int16# -> Int#
int32ToInt# :: Int32# -> Int#
intToInt8# :: Int# -> Int8#
intToInt16# :: Int# -> Int16#
intToInt32# :: Int# -> Int32#
word8ToInt# :: Word8# -> Int#
word8ToInt16# :: Word8# -> Int16#
word8ToInt32# :: Word8# -> Int32#
charToWord32# :: Char# -> Word32#
word8ToChar# :: Word8# -> Char#
word16ToChar# :: Word16# -> Char#
word32ToChar# :: Word32# -> Char#
wordToChar# :: Word# -> Char#
plusWord8# :: Word8# -> Word8# -> Word8#
uncheckedShiftRLWord16# :: Word# -> Int# -> Word#
plusWord16# :: Word16# -> Word16# -> Word16#
uncheckedShiftRLWord32# :: Word# -> Int# -> Word#
plusWord32# :: Word32# -> Word32# -> Word32#
plusInt8# :: Int8# -> Int8# -> Int8#
plusInt16# :: Int16# -> Int16# -> Int16#
plusInt32# :: Int32# -> Int32# -> Int32#

Documentation

bool# :: Int# -> Bool Source #

turn an Int# into a Bool

data PinnedStatus Source #

Flag record whether a specific byte array is pinned or not

Constructors

Pinned
Unpinned

Instances

Instances details

Eq PinnedStatus Source #
Instance details Defined in Basement.Compat.Primitive Methods (==) :: PinnedStatus -> PinnedStatus -> Bool # (/=) :: PinnedStatus -> PinnedStatus -> Bool #

toPinnedStatus# :: Pinned# -> PinnedStatus Source #

compatMkWeak# :: o -> b -> IO () -> State# RealWorld -> (# State# RealWorld, Weak# b #) Source #

A mkWeak# version that keep working on 8.0

signature change in ghc-prim: * 0.4: mkWeak RealWorld -> ( RealWorld, Weak) * 0.5 :mkWeak RealWorld -> ( RealWorld, c RealWorld -> ( RealWorld, Weak)

compatIsByteArrayPinned# :: ByteArray# -> Pinned# Source #

compatIsMutableByteArrayPinned# :: MutableByteArray# s -> Pinned# Source #

unsafeCoerce# :: forall (k0 :: RuntimeRep) (k1 :: RuntimeRep) (a :: TYPE k0) (b :: TYPE k1). a -> b #

The function unsafeCoerce# allows you to side-step the typechecker entirely. That is, it allows you to coerce any type into any other type. If you use this function, you had better get it right, otherwise segmentation faults await. It is generally used when you want to write a program that you know is well-typed, but where Haskell's type system is not expressive enough to prove that it is well typed.

The following uses of unsafeCoerce# are supposed to work (i.e. not lead to spurious compile-time or run-time crashes):

Casting any lifted type to Any
Casting Any back to the real type
Casting an unboxed type to another unboxed type of the same size. (Casting between floating-point and integral types does not work. See the GHC.Float module for functions to do work.)
Casting between two types that have the same runtime representation. One case is when the two types differ only in "phantom" type parameters, for example Ptr Int to Ptr Float, or [Int] to [Float] when the list is known to be empty. Also, a newtype of a type T has the same representation at runtime as T.

Other uses of unsafeCoerce# are undefined. In particular, you should not use unsafeCoerce# to cast a T to an algebraic data type D, unless T is also an algebraic data type. For example, do not cast Int->Int to Bool, even if you later cast that Bool back to Int->Int before applying it. The reasons have to do with GHC's internal representation details (for the cognoscenti, data values can be entered but function closures cannot). If you want a safe type to cast things to, use Any, which is not an algebraic data type.

Warning: this can fail with an unchecked exception.

data Word #

A Word is an unsigned integral type, with the same size as Int.

Constructors

W# Word#

Instances

Instances details

Bounded Word	Since: base-2.1
Instance details Defined in GHC.Enum Methods minBound :: Word # maxBound :: Word #
Enum Word	Since: base-2.1
Instance details Defined in GHC.Enum Methods succ :: Word -> Word # pred :: Word -> Word # toEnum :: Int -> Word # fromEnum :: Word -> Int # enumFrom :: Word -> [Word] # enumFromThen :: Word -> Word -> [Word] # enumFromTo :: Word -> Word -> [Word] # enumFromThenTo :: Word -> Word -> Word -> [Word] #
Eq Word
Instance details Defined in GHC.Classes Methods (==) :: Word -> Word -> Bool # (/=) :: Word -> Word -> Bool #
Integral Word	Since: base-2.1
Instance details Defined in GHC.Real Methods quot :: Word -> Word -> Word # rem :: Word -> Word -> Word # div :: Word -> Word -> Word # mod :: Word -> Word -> Word # quotRem :: Word -> Word -> (Word, Word) # divMod :: Word -> Word -> (Word, Word) # toInteger :: Word -> Integer #
Data Word	Since: base-4.0.0.0
Instance details Defined in Data.Data Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Word -> c Word # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Word # toConstr :: Word -> Constr # dataTypeOf :: Word -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Word) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Word) # gmapT :: (forall b. Data b => b -> b) -> Word -> Word # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Word -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Word -> r # gmapQ :: (forall d. Data d => d -> u) -> Word -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Word -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Word -> m Word # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Word -> m Word # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Word -> m Word #
Num Word	Since: base-2.1
Instance details Defined in GHC.Num Methods (+) :: Word -> Word -> Word # (-) :: Word -> Word -> Word # (*) :: Word -> Word -> Word # negate :: Word -> Word # abs :: Word -> Word # signum :: Word -> Word # fromInteger :: Integer -> Word #
Ord Word
Instance details Defined in GHC.Classes Methods compare :: Word -> Word -> Ordering # (<) :: Word -> Word -> Bool # (<=) :: Word -> Word -> Bool # (>) :: Word -> Word -> Bool # (>=) :: Word -> Word -> Bool # max :: Word -> Word -> Word # min :: Word -> Word -> Word #
Read Word	Since: base-4.5.0.0
Instance details Defined in GHC.Read Methods readsPrec :: Int -> ReadS Word # readList :: ReadS [Word] # readPrec :: ReadPrec Word # readListPrec :: ReadPrec [Word] #
Real Word	Since: base-2.1
Instance details Defined in GHC.Real Methods toRational :: Word -> Rational #
Show Word	Since: base-2.1
Instance details Defined in GHC.Show Methods showsPrec :: Int -> Word -> ShowS # show :: Word -> String # showList :: [Word] -> ShowS #
Ix Word	Since: base-4.6.0.0
Instance details Defined in GHC.Ix Methods range :: (Word, Word) -> [Word] # index :: (Word, Word) -> Word -> Int # unsafeIndex :: (Word, Word) -> Word -> Int # inRange :: (Word, Word) -> Word -> Bool # rangeSize :: (Word, Word) -> Int # unsafeRangeSize :: (Word, Word) -> Int #
Storable Word	Since: base-2.1
Instance details Defined in Foreign.Storable Methods sizeOf :: Word -> Int # alignment :: Word -> Int # peekElemOff :: Ptr Word -> Int -> IO Word # pokeElemOff :: Ptr Word -> Int -> Word -> IO () # peekByteOff :: Ptr b -> Int -> IO Word # pokeByteOff :: Ptr b -> Int -> Word -> IO () # peek :: Ptr Word -> IO Word # poke :: Ptr Word -> Word -> IO () #
Bits Word	Since: base-2.1
Instance details Defined in Data.Bits Methods (.&.) :: Word -> Word -> Word # (.\|.) :: Word -> Word -> Word # xor :: Word -> Word -> Word # complement :: Word -> Word # shift :: Word -> Int -> Word # rotate :: Word -> Int -> Word # zeroBits :: Word # bit :: Int -> Word # setBit :: Word -> Int -> Word # clearBit :: Word -> Int -> Word # complementBit :: Word -> Int -> Word # testBit :: Word -> Int -> Bool # bitSizeMaybe :: Word -> Maybe Int # bitSize :: Word -> Int # isSigned :: Word -> Bool # shiftL :: Word -> Int -> Word # unsafeShiftL :: Word -> Int -> Word # shiftR :: Word -> Int -> Word # unsafeShiftR :: Word -> Int -> Word # rotateL :: Word -> Int -> Word # rotateR :: Word -> Int -> Word # popCount :: Word -> Int #
FiniteBits Word	Since: base-4.6.0.0
Instance details Defined in Data.Bits Methods finiteBitSize :: Word -> Int # countLeadingZeros :: Word -> Int # countTrailingZeros :: Word -> Int #
HasNegation Word Source #
Instance details Defined in Basement.Compat.NumLiteral Methods negate :: Word -> Word Source #
Integral Word Source #
Instance details Defined in Basement.Compat.NumLiteral Methods fromInteger :: Integer -> Word Source #
IsNatural Word Source #
Instance details Defined in Basement.Numerical.Number Methods toNatural :: Word -> Natural Source #
IsIntegral Word Source #
Instance details Defined in Basement.Numerical.Number Methods toInteger :: Word -> Integer Source #
Subtractive Word Source #
Instance details Defined in Basement.Numerical.Subtractive Associated Types type Difference Word Source # Methods (-) :: Word -> Word -> Difference Word Source #
Additive Word Source #
Instance details Defined in Basement.Numerical.Additive Methods azero :: Word Source # (+) :: Word -> Word -> Word Source # scale :: IsNatural n => n -> Word -> Word Source #
IDivisible Word Source #
Instance details Defined in Basement.Numerical.Multiplicative Methods div :: Word -> Word -> Word Source # mod :: Word -> Word -> Word Source # divMod :: Word -> Word -> (Word, Word) Source #
Multiplicative Word Source #
Instance details Defined in Basement.Numerical.Multiplicative Methods midentity :: Word Source # (*) :: Word -> Word -> Word Source # (^) :: (IsNatural n, Enum n, IDivisible n) => Word -> n -> Word Source #
PrimMemoryComparable Word Source #
Instance details Defined in Basement.PrimType
PrimType Word Source #
Instance details Defined in Basement.PrimType Associated Types type PrimSize Word :: Nat Source # Methods primSizeInBytes :: Proxy Word -> CountOf Word8 Source # primShiftToBytes :: Proxy Word -> Int Source # primBaUIndex :: ByteArray# -> Offset Word -> Word Source # primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word -> prim Word Source # primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word -> Word -> prim () Source # primAddrIndex :: Addr# -> Offset Word -> Word Source # primAddrRead :: PrimMonad prim => Addr# -> Offset Word -> prim Word Source # primAddrWrite :: PrimMonad prim => Addr# -> Offset Word -> Word -> prim () Source #
NormalForm Word Source #
Instance details Defined in Basement.NormalForm Methods toNormalForm :: Word -> () Source #
BitOps Word Source #
Instance details Defined in Basement.Bits Methods (.&.) :: Word -> Word -> Word Source # (.\|.) :: Word -> Word -> Word Source # (.^.) :: Word -> Word -> Word Source # (.<<.) :: Word -> CountOf Bool -> Word Source # (.>>.) :: Word -> CountOf Bool -> Word Source # bit :: Offset Bool -> Word Source # isBitSet :: Word -> Offset Bool -> Bool Source # setBit :: Word -> Offset Bool -> Word Source # clearBit :: Word -> Offset Bool -> Word Source #
FiniteBitsOps Word Source #
Instance details Defined in Basement.Bits Methods numberOfBits :: Word -> CountOf Bool Source # rotateL :: Word -> CountOf Bool -> Word Source # rotateR :: Word -> CountOf Bool -> Word Source # popCount :: Word -> CountOf Bool Source # bitFlip :: Word -> Word Source # countLeadingZeros :: Word -> CountOf Bool Source # countTrailingZeros :: Word -> CountOf Bool Source #
IntegralUpsize Word Word64 Source #
Instance details Defined in Basement.IntegralConv Methods integralUpsize :: Word -> Word64 Source #
IntegralUpsize Word8 Word Source #
Instance details Defined in Basement.IntegralConv Methods integralUpsize :: Word8 -> Word Source #
IntegralUpsize Word16 Word Source #
Instance details Defined in Basement.IntegralConv Methods integralUpsize :: Word16 -> Word Source #
IntegralUpsize Word32 Word Source #
Instance details Defined in Basement.IntegralConv Methods integralUpsize :: Word32 -> Word Source #
IntegralDownsize Word Word8 Source #
Instance details Defined in Basement.IntegralConv Methods integralDownsize :: Word -> Word8 Source # integralDownsizeCheck :: Word -> Maybe Word8 Source #
IntegralDownsize Word Word16 Source #
Instance details Defined in Basement.IntegralConv Methods integralDownsize :: Word -> Word16 Source # integralDownsizeCheck :: Word -> Maybe Word16 Source #
IntegralDownsize Word Word32 Source #
Instance details Defined in Basement.IntegralConv Methods integralDownsize :: Word -> Word32 Source # integralDownsizeCheck :: Word -> Maybe Word32 Source #
Cast Int Word Source #
Instance details Defined in Basement.Cast Methods cast :: Int -> Word Source #
Cast Int64 Word Source #
Instance details Defined in Basement.Cast Methods cast :: Int64 -> Word Source #
Cast Word Int Source #
Instance details Defined in Basement.Cast Methods cast :: Word -> Int Source #
Cast Word Int64 Source #
Instance details Defined in Basement.Cast Methods cast :: Word -> Int64 Source #
Cast Word Word64 Source #
Instance details Defined in Basement.Cast Methods cast :: Word -> Word64 Source #
Cast Word64 Word Source #
Instance details Defined in Basement.Cast Methods cast :: Word64 -> Word Source #
From Word Word64 Source #
Instance details Defined in Basement.From Methods from :: Word -> Word64 Source #
From Word8 Word Source #
Instance details Defined in Basement.From Methods from :: Word8 -> Word Source #
From Word16 Word Source #
Instance details Defined in Basement.From Methods from :: Word16 -> Word Source #
From Word32 Word Source #
Instance details Defined in Basement.From Methods from :: Word32 -> Word Source #
From Word (CountOf ty) Source #
Instance details Defined in Basement.From Methods from :: Word -> CountOf ty Source #
From Word (Offset ty) Source #
Instance details Defined in Basement.From Methods from :: Word -> Offset ty Source #
Generic1 (URec Word :: k -> Type)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Associated Types type Rep1 (URec Word) :: k -> Type # Methods from1 :: forall (a :: k0). URec Word a -> Rep1 (URec Word) a # to1 :: forall (a :: k0). Rep1 (URec Word) a -> URec Word a #
Foldable (UWord :: Type -> Type)	Since: base-4.9.0.0
Instance details Defined in Data.Foldable Methods fold :: Monoid m => UWord m -> m # foldMap :: Monoid m => (a -> m) -> UWord a -> m # foldMap' :: Monoid m => (a -> m) -> UWord a -> m # foldr :: (a -> b -> b) -> b -> UWord a -> b # foldr' :: (a -> b -> b) -> b -> UWord a -> b # foldl :: (b -> a -> b) -> b -> UWord a -> b # foldl' :: (b -> a -> b) -> b -> UWord a -> b # foldr1 :: (a -> a -> a) -> UWord a -> a # foldl1 :: (a -> a -> a) -> UWord a -> a # toList :: UWord a -> [a] # null :: UWord a -> Bool # length :: UWord a -> Int # elem :: Eq a => a -> UWord a -> Bool # maximum :: Ord a => UWord a -> a # minimum :: Ord a => UWord a -> a # sum :: Num a => UWord a -> a # product :: Num a => UWord a -> a #
Traversable (UWord :: Type -> Type)	Since: base-4.9.0.0
Instance details Defined in Data.Traversable Methods traverse :: Applicative f => (a -> f b) -> UWord a -> f (UWord b) # sequenceA :: Applicative f => UWord (f a) -> f (UWord a) # mapM :: Monad m => (a -> m b) -> UWord a -> m (UWord b) # sequence :: Monad m => UWord (m a) -> m (UWord a) #
From (CountOf ty) Word Source #
Instance details Defined in Basement.From Methods from :: CountOf ty -> Word Source #
Functor (URec Word :: Type -> Type)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods fmap :: (a -> b) -> URec Word a -> URec Word b # (<$) :: a -> URec Word b -> URec Word a #
Eq (URec Word p)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods (==) :: URec Word p -> URec Word p -> Bool # (/=) :: URec Word p -> URec Word p -> Bool #
Ord (URec Word p)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods compare :: URec Word p -> URec Word p -> Ordering # (<) :: URec Word p -> URec Word p -> Bool # (<=) :: URec Word p -> URec Word p -> Bool # (>) :: URec Word p -> URec Word p -> Bool # (>=) :: URec Word p -> URec Word p -> Bool # max :: URec Word p -> URec Word p -> URec Word p # min :: URec Word p -> URec Word p -> URec Word p #
Show (URec Word p)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods showsPrec :: Int -> URec Word p -> ShowS # show :: URec Word p -> String # showList :: [URec Word p] -> ShowS #
Generic (URec Word p)	Since: base-4.9.0.0
Instance details Defined in GHC.Generics Associated Types type Rep (URec Word p) :: Type -> Type # Methods from :: URec Word p -> Rep (URec Word p) x # to :: Rep (URec Word p) x -> URec Word p #
type NatNumMaxBound Word Source #
Instance details Defined in Basement.Nat type NatNumMaxBound Word = NatNumMaxBound Word64
type Difference Word Source #
Instance details Defined in Basement.Numerical.Subtractive type Difference Word = Word
type PrimSize Word Source #
Instance details Defined in Basement.PrimType type PrimSize Word = 8
data URec Word (p :: k)	Used for marking occurrences of `Word#` Since: base-4.9.0.0
Instance details Defined in GHC.Generics data URec Word (p :: k) = UWord { uWord# :: Word# }
type Rep1 (URec Word :: k -> Type)
Instance details Defined in GHC.Generics type Rep1 (URec Word :: k -> Type) = D1 ('MetaData "URec" "GHC.Generics" "base" 'False) (C1 ('MetaCons "UWord" 'PrefixI 'True) (S1 ('MetaSel ('Just "uWord#") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (UWord :: k -> Type)))
type Rep (URec Word p)
Instance details Defined in GHC.Generics type Rep (URec Word p) = D1 ('MetaData "URec" "GHC.Generics" "base" 'False) (C1 ('MetaCons "UWord" 'PrefixI 'True) (S1 ('MetaSel ('Just "uWord#") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (UWord :: Type -> Type)))