Copyright	(c) 2019 Edward Kmett
License	BSD-2-Clause OR Apache-2.0
Maintainer	Edward Kmett <ekmett@gmail.com>
Stability	experimental
Portability	non-portable
Safe Haskell	Trustworthy
Language	Haskell2010

Foreign.Const.ForeignPtr

Contents

const foreign pointer operations
const-preserving foreign pointer operations
const agnostic foreign pointer operations

Description

Synopsis

data ConstForeignPtr a
constForeignPtr :: AForeignPtr fp => fp a -> ConstForeignPtr a
type AForeignPtr = Constable ConstForeignPtr
newConstForeignPtr :: forall p a. APtr p => FinalizerPtr a -> p a -> IO (ConstForeignPtr a)
newConstForeignPtr_ :: forall p a. APtr p => p a -> IO (ConstForeignPtr a)
castConstForeignPtr :: forall fp a b. AForeignPtr fp => fp a -> ConstForeignPtr b
plusConstForeignPtr :: forall fp a b. AForeignPtr fp => fp a -> Int -> ConstForeignPtr b
newConstForeignPtrEnv :: forall p env a. APtr p => FinalizerEnvPtr env a -> Ptr env -> p a -> IO (ConstForeignPtr a)
withConstForeignPtr :: forall fp a r. AForeignPtr fp => fp a -> (ConstPtr a -> IO r) -> IO r
type family Unforeign (fp :: Type -> Type) :: Type -> Type
plusAForeignPtr :: forall fp a b. AForeignPtr fp => fp a -> Int -> fp b
withAForeignPtr :: forall fp a r. (AForeignPtr fp, APtr (Unforeign fp)) => fp a -> (Unforeign fp a -> IO r) -> IO r
addAForeignPtrFinalizer :: forall fp a. AForeignPtr fp => FinalizerPtr a -> fp a -> IO ()
addAForeignPtrFinalizerEnv :: forall fp env a. AForeignPtr fp => FinalizerEnvPtr env a -> Ptr env -> fp a -> IO ()
finalizeAForeignPtr :: forall fp a. AForeignPtr fp => fp a -> IO ()
touchAForeignPtr :: forall fp a. AForeignPtr fp => fp a -> IO ()

Documentation

data ConstForeignPtr a Source #

Instances

DiffTorsor ConstForeignPtr Source #
Instance details Defined in Data.Const.Unsafe Methods act :: Diff a b -> ConstForeignPtr a -> ConstForeignPtr b diff :: ConstForeignPtr b -> ConstForeignPtr a -> Diff a b
Eq (ConstForeignPtr a) Source #
Instance details Defined in Data.Const.Unsafe Methods (==) :: ConstForeignPtr a -> ConstForeignPtr a -> Bool # (/=) :: ConstForeignPtr a -> ConstForeignPtr a -> Bool #
Data a => Data (ConstForeignPtr a) Source #
Instance details Defined in Data.Const.Unsafe Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConstForeignPtr a -> c (ConstForeignPtr a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (ConstForeignPtr a) # toConstr :: ConstForeignPtr a -> Constr # dataTypeOf :: ConstForeignPtr a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (ConstForeignPtr a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (ConstForeignPtr a)) # gmapT :: (forall b. Data b => b -> b) -> ConstForeignPtr a -> ConstForeignPtr a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConstForeignPtr a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConstForeignPtr a -> r # gmapQ :: (forall d. Data d => d -> u) -> ConstForeignPtr a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ConstForeignPtr a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConstForeignPtr a -> m (ConstForeignPtr a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConstForeignPtr a -> m (ConstForeignPtr a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConstForeignPtr a -> m (ConstForeignPtr a) #
Ord (ConstForeignPtr a) Source #
Instance details Defined in Data.Const.Unsafe Methods compare :: ConstForeignPtr a -> ConstForeignPtr a -> Ordering # (<) :: ConstForeignPtr a -> ConstForeignPtr a -> Bool # (<=) :: ConstForeignPtr a -> ConstForeignPtr a -> Bool # (>) :: ConstForeignPtr a -> ConstForeignPtr a -> Bool # (>=) :: ConstForeignPtr a -> ConstForeignPtr a -> Bool # max :: ConstForeignPtr a -> ConstForeignPtr a -> ConstForeignPtr a # min :: ConstForeignPtr a -> ConstForeignPtr a -> ConstForeignPtr a #
Show (ConstForeignPtr a) Source #
Instance details Defined in Data.Const.Unsafe Methods showsPrec :: Int -> ConstForeignPtr a -> ShowS # show :: ConstForeignPtr a -> String # showList :: [ConstForeignPtr a] -> ShowS #
Constable ConstForeignPtr ForeignPtr Source #
Instance details Defined in Data.Const.Unsafe
Constable ConstForeignPtr ConstForeignPtr Source #
Instance details Defined in Data.Const.Unsafe
type Unforeign ConstForeignPtr Source #
Instance details Defined in Foreign.Const.ForeignPtr type Unforeign ConstForeignPtr = ConstPtr

constForeignPtr :: AForeignPtr fp => fp a -> ConstForeignPtr a Source #

type AForeignPtr = Constable ConstForeignPtr Source #

const foreign pointer operations

newConstForeignPtr :: forall p a. APtr p => FinalizerPtr a -> p a -> IO (ConstForeignPtr a) Source #

newConstForeignPtr_ :: forall p a. APtr p => p a -> IO (ConstForeignPtr a) Source #

castConstForeignPtr :: forall fp a b. AForeignPtr fp => fp a -> ConstForeignPtr b Source #

plusConstForeignPtr :: forall fp a b. AForeignPtr fp => fp a -> Int -> ConstForeignPtr b Source #

newConstForeignPtrEnv :: forall p env a. APtr p => FinalizerEnvPtr env a -> Ptr env -> p a -> IO (ConstForeignPtr a) Source #

withConstForeignPtr :: forall fp a r. AForeignPtr fp => fp a -> (ConstPtr a -> IO r) -> IO r Source #

const-preserving foreign pointer operations

type family Unforeign (fp :: Type -> Type) :: Type -> Type Source #

Instances

type Unforeign ForeignPtr Source #
Instance details Defined in Foreign.Const.ForeignPtr type Unforeign ForeignPtr = Ptr
type Unforeign ConstForeignPtr Source #
Instance details Defined in Foreign.Const.ForeignPtr type Unforeign ConstForeignPtr = ConstPtr

plusAForeignPtr :: forall fp a b. AForeignPtr fp => fp a -> Int -> fp b Source #

withAForeignPtr :: forall fp a r. (AForeignPtr fp, APtr (Unforeign fp)) => fp a -> (Unforeign fp a -> IO r) -> IO r Source #

const agnostic foreign pointer operations

addAForeignPtrFinalizer :: forall fp a. AForeignPtr fp => FinalizerPtr a -> fp a -> IO () Source #

addAForeignPtrFinalizerEnv :: forall fp env a. AForeignPtr fp => FinalizerEnvPtr env a -> Ptr env -> fp a -> IO () Source #

finalizeAForeignPtr :: forall fp a. AForeignPtr fp => fp a -> IO () Source #

touchAForeignPtr :: forall fp a. AForeignPtr fp => fp a -> IO () Source #