Safe Haskell	Safe-Inferred
Language	Haskell2010

Ki.Unlifted

Description

The ki API, generalized to use MonadUnliftIO.

Note: See Ki for the main module documentation. Any documentation you see here is incidental, and only a result of re-exporting symbols directly from Ki.

Documentation

data Scope #

data Thread a #

Instances

Instances details

Functor Thread
Instance details Defined in Ki.Internal.Thread Methods fmap :: (a -> b) -> Thread a -> Thread b # (<$) :: a -> Thread b -> Thread a #
Eq (Thread a)
Instance details Defined in Ki.Internal.Thread Methods (==) :: Thread a -> Thread a -> Bool # (/=) :: Thread a -> Thread a -> Bool #
Ord (Thread a)
Instance details Defined in Ki.Internal.Thread Methods compare :: Thread a -> Thread a -> Ordering # (<) :: Thread a -> Thread a -> Bool # (<=) :: Thread a -> Thread a -> Bool # (>) :: Thread a -> Thread a -> Bool # (>=) :: Thread a -> Thread a -> Bool # max :: Thread a -> Thread a -> Thread a # min :: Thread a -> Thread a -> Thread a #

scoped :: forall a m. MonadUnliftIO m => (Scope -> m a) -> m a Source #

fork :: forall a m. MonadUnliftIO m => Scope -> m a -> m (Thread a) Source #

forkTry :: (Exception e, MonadUnliftIO m) => Scope -> m a -> m (Thread (Either e a)) Source #

await :: Thread a -> STM a #

awaitAll :: Scope -> STM () #

fork_ :: MonadUnliftIO m => Scope -> m Void -> m () Source #

forkWith :: forall a m. MonadUnliftIO m => Scope -> ThreadOptions -> m a -> m (Thread a) Source #

forkWith_ :: MonadUnliftIO m => Scope -> ThreadOptions -> m Void -> m () Source #

forkTryWith :: (Exception e, MonadUnliftIO m) => Scope -> ThreadOptions -> m a -> m (Thread (Either e a)) Source #

data ThreadOptions #

Constructors

ThreadOptions
Fields affinity :: ThreadAffinity allocationLimit :: Maybe ByteCount label :: String maskingState :: MaskingState

Instances

Instances details

Show ThreadOptions
Instance details Defined in Ki.Internal.Thread Methods showsPrec :: Int -> ThreadOptions -> ShowS # show :: ThreadOptions -> String # showList :: [ThreadOptions] -> ShowS #
Eq ThreadOptions
Instance details Defined in Ki.Internal.Thread Methods (==) :: ThreadOptions -> ThreadOptions -> Bool # (/=) :: ThreadOptions -> ThreadOptions -> Bool #

defaultThreadOptions :: ThreadOptions #

data ThreadAffinity #

Constructors

Unbound
Capability Int
OsThread

Instances

Instances details

Show ThreadAffinity
Instance details Defined in Ki.Internal.Thread Methods showsPrec :: Int -> ThreadAffinity -> ShowS # show :: ThreadAffinity -> String # showList :: [ThreadAffinity] -> ShowS #
Eq ThreadAffinity
Instance details Defined in Ki.Internal.Thread Methods (==) :: ThreadAffinity -> ThreadAffinity -> Bool # (/=) :: ThreadAffinity -> ThreadAffinity -> Bool #

data ByteCount #

Instances

Instances details

Show ByteCount
Instance details Defined in Ki.Internal.ByteCount Methods showsPrec :: Int -> ByteCount -> ShowS # show :: ByteCount -> String # showList :: [ByteCount] -> ShowS #
Eq ByteCount
Instance details Defined in Ki.Internal.ByteCount Methods (==) :: ByteCount -> ByteCount -> Bool # (/=) :: ByteCount -> ByteCount -> Bool #
Ord ByteCount
Instance details Defined in Ki.Internal.ByteCount Methods compare :: ByteCount -> ByteCount -> Ordering # (<) :: ByteCount -> ByteCount -> Bool # (<=) :: ByteCount -> ByteCount -> Bool # (>) :: ByteCount -> ByteCount -> Bool # (>=) :: ByteCount -> ByteCount -> Bool # max :: ByteCount -> ByteCount -> ByteCount # min :: ByteCount -> ByteCount -> ByteCount #

kilobytes :: Natural -> ByteCount #

megabytes :: Natural -> ByteCount #