Safe Haskell	None
Language	Haskell2010

Shpadoinkle.Core

Contents

Base Types
JSVal Wrappers
Backend Interface
The Shpadoinkle Primitive
Re-Exports

Description

Shpadoinkle is an abstract frontend programming model, with one-way data flow, and a single source of truth. This module provides a parsimonious implementation of Shpadoinkle with few implementation details.

Synopsis

newtype Html m a = Html {
- unHtml :: forall r. (Text -> [(Text, Prop m a)] -> [r] -> r) -> (JSM (RawNode, STM (Continuation m a)) -> r) -> (Text -> r) -> r
}
data Prop :: (Type -> Type) -> Type -> Type where
- PData :: JSVal -> Prop m a
- PText :: Text -> Prop m a
- PFlag :: Bool -> Prop m a
- PPotato :: (RawNode -> JSM (STM (Continuation m a))) -> Prop m a
- PListener :: (RawNode -> RawEvent -> JSM (Continuation m a)) -> Prop m a
newtype Props m a = Props {
- getProps :: Map Text (Prop m a)
}
fromProps :: Props m a -> [(Text, Prop m a)]
toProps :: Applicative m => [(Text, Prop m a)] -> Props m a
dataProp :: JSVal -> Prop m a
flagProp :: Bool -> Prop m a
textProp :: Text -> Prop m a
listenerProp :: (RawNode -> RawEvent -> JSM (Continuation m a)) -> Prop m a
bakedProp :: (RawNode -> JSM (STM (Continuation m a))) -> Prop m a
listenRaw :: Text -> (RawNode -> RawEvent -> JSM (Continuation m a)) -> (Text, Prop m a)
listen :: Text -> (a -> a) -> (Text, Prop m a)
listenM :: Applicative m => Text -> m (a -> a) -> (Text, Prop m a)
listenM_ :: Applicative m => Text -> m () -> (Text, Prop m a)
listenC :: Text -> Continuation m a -> (Text, Prop m a)
listener :: Continuation m a -> Prop m a
h :: Text -> [(Text, Prop m a)] -> [Html m a] -> Html m a
baked :: JSM (RawNode, STM (Continuation m a)) -> Html m a
text :: Text -> Html m a
hoistHtml :: Functor m => (m ~> n) -> Html m a -> Html n a
hoistProp :: Functor m => (m ~> n) -> Prop m a -> Prop n a
cataH :: (Text -> [(Text, Prop m a)] -> [b] -> b) -> (JSM (RawNode, STM (Continuation m a)) -> b) -> (Text -> b) -> Html m a -> b
cataProp :: (JSVal -> b) -> (Text -> b) -> (Bool -> b) -> ((RawNode -> RawEvent -> JSM (Continuation m a)) -> b) -> ((RawNode -> JSM (STM (Continuation m a))) -> b) -> Prop m a -> b
mapProps :: ([(Text, Prop m a)] -> [(Text, Prop m a)]) -> Html m a -> Html m a
injectProps :: [(Text, Prop m a)] -> Html m a -> Html m a
eitherH :: Applicative m => (a -> Html m a) -> (b -> Html m b) -> Either a b -> Html m (Either a b)
htmlDecode :: JSString -> JSM JSString
newtype RawNode = RawNode {
- unRawNode :: JSVal
}
newtype RawEvent = RawEvent {
- unRawEvent :: JSVal
}
class Backend b m a | b m -> a where
- type VNode b m
- interpret :: (m ~> JSM) -> Html (b m) a -> b m (VNode b m)
- patch :: RawNode -> Maybe (VNode b m) -> VNode b m -> b m (VNode b m)
- setup :: JSM () -> JSM ()
type (~>) m n = forall a. m a -> n a
shpadoinkle :: forall b m a. Backend b m a => Monad (b m) => Eq a => (m ~> JSM) -> (TVar a -> b m ~> m) -> TVar a -> (a -> Html (b m) a) -> b m RawNode -> JSM ()
data JSM a
class (Applicative m, MonadIO m) => MonadJSM (m :: Type -> Type)
askJSM :: MonadJSM m => m JSContextRef
runJSM :: MonadIO m => JSM a -> JSContextRef -> m a
class MonadIO m => MonadUnliftIO (m :: Type -> Type) where
- askUnliftIO :: m (UnliftIO m)
- withRunInIO :: ((forall a. m a -> IO a) -> IO b) -> m b
newtype UnliftIO (m :: Type -> Type) = UnliftIO {
- unliftIO :: forall a. m a -> IO a
}
liftJSM :: MonadJSM m => JSM a -> m a
writeTVar :: TVar a -> a -> STM ()
readTVar :: TVar a -> STM a
data STM a
data TVar a
modifyTVar :: TVar a -> (a -> a) -> STM ()
readTVarIO :: MonadIO m => TVar a -> m a
newTVarIO :: MonadIO m => a -> m (TVar a)
retrySTM :: STM a
atomically :: MonadIO m => STM a -> m a

Base Types

newtype Html m a Source #

This is the core type in Backend. Please note, this is NOT the Virtual DOM used by Backend. This type backs a DSL that is then interpreted into Virtual DOM by the Backend of your choosing. HTML comments are not supported. This is Church encoded for performance reasons.

Constructors

Html
Fields unHtml :: forall r. (Text -> [(Text, Prop m a)] -> [r] -> r) -> (JSM (RawNode, STM (Continuation m a)) -> r) -> (Text -> r) -> r

Instances

Continuous Html Source #	Given a lens, you can change the type of an Html by using the lens to convert the types of the Continuations inside it.
Instance details Defined in Shpadoinkle.Core Methods mapC :: (Continuation m a -> Continuation m b) -> Html m a -> Html m b Source #
IsString (Html m a) Source #	Strings are overloaded as HTML text nodes: `"hiya" = TextNode "hiya"`
Instance details Defined in Shpadoinkle.Core Methods fromString :: String -> Html m a Source #

data Prop :: (Type -> Type) -> Type -> Type where Source #

Properties of a DOM node. Backend does not use attributes directly, but rather is focused on the more capable properties that may be set on a DOM node in JavaScript. If you wish to add attributes, you may do so by setting its corresponding property.

Constructors

PData :: JSVal -> Prop m a	A data property, these do NOT appear in static rendering
PText :: Text -> Prop m a	A text property
PFlag :: Bool -> Prop m a	A boolean property
PPotato :: (RawNode -> JSM (STM (Continuation m a))) -> Prop m a	Bake a custom property The STM Monad will be called recursively. The semantics here is roughly an event stream of continuations.
PListener :: (RawNode -> RawEvent -> JSM (Continuation m a)) -> Prop m a	Event listeners are provided with the `RawNode` target, and the `RawEvent`, and may perform a monadic action such as a side effect. This is the one and only place where you may introduce a custom monadic action. The JSM to compute the Continuation must be synchronous and non-blocking; otherwise race conditions may result from a Pure Continuation which sets the state based on a previous state captured by the closure. Such Continuations must be executed synchronously during event propagation, and that may not be the case if the code to compute the Continuation of some listener is blocking.

Instances

Continuous Prop Source #	Given a lens, you can change the type of a Prop by using the lens to convert the types of the Continuations which it contains if it is a listener.
Instance details Defined in Shpadoinkle.Core Methods mapC :: (Continuation m a -> Continuation m b) -> Prop m a -> Prop m b Source #
IsString [(Text, Prop m a)] Source #	Strings are overloaded as the class property: `"active" = ("className", PText "active")`
Instance details Defined in Shpadoinkle.Core Methods fromString :: String -> [(Text, Prop m a)] Source #
Eq (Prop m a) Source #
Instance details Defined in Shpadoinkle.Core Methods (==) :: Prop m a -> Prop m a -> Bool Source # (/=) :: Prop m a -> Prop m a -> Bool Source #
IsString (Prop m a) Source #	Strings are overloaded as text props: `("id", "foo") = ("id", PText "foo")`
Instance details Defined in Shpadoinkle.Core Methods fromString :: String -> Prop m a Source #

newtype Props m a Source #

Constructors

Props
Fields getProps :: Map Text (Prop m a)

Instances

Continuous Props Source #	Given a lens, you can change the type of a Props by using the lens to convert the types of the Continuations inside.
Instance details Defined in Shpadoinkle.Core Methods mapC :: (Continuation m a -> Continuation m b) -> Props m a -> Props m b Source #
Applicative m => Semigroup (Props m a) Source #
Instance details Defined in Shpadoinkle.Core Methods (<>) :: Props m a -> Props m a -> Props m a Source # sconcat :: NonEmpty (Props m a) -> Props m a Source # stimes :: Integral b => b -> Props m a -> Props m a Source #
Applicative m => Monoid (Props m a) Source #
Instance details Defined in Shpadoinkle.Core Methods mempty :: Props m a Source # mappend :: Props m a -> Props m a -> Props m a Source # mconcat :: [Props m a] -> Props m a Source #

fromProps :: Props m a -> [(Text, Prop m a)] Source #

toProps :: Applicative m => [(Text, Prop m a)] -> Props m a Source #

Prop Constructors

dataProp :: JSVal -> Prop m a Source #

Create a data property.

flagProp :: Bool -> Prop m a Source #

textProp :: Text -> Prop m a Source #

Create a text property.

listenerProp :: (RawNode -> RawEvent -> JSM (Continuation m a)) -> Prop m a Source #

Create an event listener property.

bakedProp :: (RawNode -> JSM (STM (Continuation m a))) -> Prop m a Source #

Create a delicious proptato.

Listeners

listenRaw :: Text -> (RawNode -> RawEvent -> JSM (Continuation m a)) -> (Text, Prop m a) Source #

Construct a listener from its name and an event handler.

listen :: Text -> (a -> a) -> (Text, Prop m a) Source #

Construct a listener from its Text name and an output value.

listenM :: Applicative m => Text -> m (a -> a) -> (Text, Prop m a) Source #

Construct a listener from its name and a simple monadic event handler.

listenM_ :: Applicative m => Text -> m () -> (Text, Prop m a) Source #

Construct a listener from its name and a simple stateless monadic event handler.

listenC :: Text -> Continuation m a -> (Text, Prop m a) Source #

Construct a listener from its name and an event handler.

listener :: Continuation m a -> Prop m a Source #

Construct a simple listener property that will perform an action.

Html Constructors

h :: Text -> [(Text, Prop m a)] -> [Html m a] -> Html m a Source #

Construct an HTML element JSX-style.

baked :: JSM (RawNode, STM (Continuation m a)) -> Html m a Source #

Construct a Potato from a JSM action producing a RawNode.

text :: Text -> Html m a Source #

Construct a text node.

Hoists

hoistHtml :: Functor m => (m ~> n) -> Html m a -> Html n a Source #

If you can provide a Natural Transformation from one Functor to another then you may change the action of Html.

hoistProp :: Functor m => (m ~> n) -> Prop m a -> Prop n a Source #

If you can provide a Natural Transformation from one Functor to another then you may change the action of Prop.

Catamorphisms

cataH :: (Text -> [(Text, Prop m a)] -> [b] -> b) -> (JSM (RawNode, STM (Continuation m a)) -> b) -> (Text -> b) -> Html m a -> b Source #

Fold an HTML element, i.e. transform an h-algebra into an h-catamorphism.

cataProp :: (JSVal -> b) -> (Text -> b) -> (Bool -> b) -> ((RawNode -> RawEvent -> JSM (Continuation m a)) -> b) -> ((RawNode -> JSM (STM (Continuation m a))) -> b) -> Prop m a -> b Source #

Transform a p-algebra into a p-catamorphism. This is like polymorphic pattern matching.

Utilities

mapProps :: ([(Text, Prop m a)] -> [(Text, Prop m a)]) -> Html m a -> Html m a Source #

Transform the properties of some Node. This has no effect on TextNodes or Potatoes.

injectProps :: [(Text, Prop m a)] -> Html m a -> Html m a Source #

Inject props into an existing Node.

eitherH :: Applicative m => (a -> Html m a) -> (b -> Html m b) -> Either a b -> Html m (Either a b) Source #

Construct an HTML element out of heterogeneous alternatives.

htmlDecode :: JSString -> JSM JSString Source #

JSVal Wrappers

newtype RawNode Source #

A DOM node reference. Useful for building baked potatoes and binding a Backend view to the page

Constructors

RawNode
Fields unRawNode :: JSVal

Instances

ToJSVal RawNode Source #
Instance details Defined in Shpadoinkle.Core Methods toJSVal :: RawNode -> JSM JSVal Source # toJSValListOf :: [RawNode] -> JSM JSVal Source #
FromJSVal RawNode Source #
Instance details Defined in Shpadoinkle.Core Methods fromJSVal :: JSVal -> JSM (Maybe RawNode) Source # fromJSValUnchecked :: JSVal -> JSM RawNode Source # fromJSValListOf :: JSVal -> JSM (Maybe [RawNode]) Source # fromJSValUncheckedListOf :: JSVal -> JSM [RawNode] Source #

newtype RawEvent Source #

A raw event object reference

Constructors

RawEvent
Fields unRawEvent :: JSVal

Instances

ToJSVal RawEvent Source #
Instance details Defined in Shpadoinkle.Core Methods toJSVal :: RawEvent -> JSM JSVal Source # toJSValListOf :: [RawEvent] -> JSM JSVal Source #
FromJSVal RawEvent Source #
Instance details Defined in Shpadoinkle.Core Methods fromJSVal :: JSVal -> JSM (Maybe RawEvent) Source # fromJSValUnchecked :: JSVal -> JSM RawEvent Source # fromJSValListOf :: JSVal -> JSM (Maybe [RawEvent]) Source # fromJSValUncheckedListOf :: JSVal -> JSM [RawEvent] Source #

Backend Interface

class Backend b m a | b m -> a where Source #

The Backend class describes a backend that can render Html. Backends are generally Monad Transformers b over some Monad m.

patch raw Nothing >=> patch raw Nothing = patch raw Nothing

Associated Types

type VNode b m Source #

VNode type family allows backends to have their own Virtual DOM. As such we can change out the rendering of our Backend view with new backends without updating our view logic.

Methods

interpret Source #

Arguments

:: (m ~> JSM)	Natural transformation for some `m` to `JSM` (this is how a Backend gets access to `JSM` to perform the rendering side effects)
-> Html (b m) a	`Html` to interpret
-> b m (VNode b m)	Effect producing the Virtual DOM representation

A backend must be able to interpret Html into its own internal Virtual DOM.

patch Source #

Arguments

:: RawNode	The container for rendering the Backend view
-> Maybe (VNode b m)	Perhaps there is a previous Virtual DOM to diff against. The value will be `Nothing` on the first run.
-> VNode b m	New Virtual DOM to render
-> b m (VNode b m)	Effect producing an updated Virtual DOM. This is not needed by all backends. Some JavaScript-based backends need to do this for the next tick. Regardless, whatever `VNode` the effect produces will be passed as the previous Virtual DOM on the next render.

A Backend must be able to patch the RawNode containing the view, with a new view if the Virtual DOM changed.

setup :: JSM () -> JSM () Source #

A Backend may perform some imperative setup steps.

type (~>) m n = forall a. m a -> n a Source #

Natural Transformation

The Shpadoinkle Primitive

shpadoinkle Source #

Arguments

:: Backend b m a
=> Monad (b m)
=> Eq a
=> (m ~> JSM)	How to get to JSM?
-> (TVar a -> b m ~> m)	What backend are we running?
-> TVar a	How can we know when to update?
-> (a -> Html (b m) a)	How should the HTML look?
-> b m RawNode	Where do we render?
-> JSM ()

The core view instantiation function combines a backend, a territory, and a model and renders the Backend view to the page.

Re-Exports

data JSM a Source #

The JSM monad keeps track of the JavaScript execution context.

When using GHCJS it is IO.

Given a JSM function and a JSContextRef you can run the function like this...

runJSM jsmFunction javaScriptContext

Instances

Monad JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods (>>=) :: JSM a -> (a -> JSM b) -> JSM b Source # (>>) :: JSM a -> JSM b -> JSM b Source # return :: a -> JSM a Source # fail :: String -> JSM a Source #
Functor JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods fmap :: (a -> b) -> JSM a -> JSM b Source # (<$) :: a -> JSM b -> JSM a Source #
MonadFix JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods mfix :: (a -> JSM a) -> JSM a Source #
MonadFail JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods fail :: String -> JSM a Source #
Applicative JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods pure :: a -> JSM a Source # (<>) :: JSM (a -> b) -> JSM a -> JSM b Source # liftA2 :: (a -> b -> c) -> JSM a -> JSM b -> JSM c Source # (>) :: JSM a -> JSM b -> JSM b Source # (<*) :: JSM a -> JSM b -> JSM a Source #
MonadIO JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftIO :: IO a -> JSM a Source #
MonadThrow JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods throwM :: Exception e => e -> JSM a Source #
MonadCatch JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods catch :: Exception e => JSM a -> (e -> JSM a) -> JSM a Source #
MonadMask JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods mask :: ((forall a. JSM a -> JSM a) -> JSM b) -> JSM b Source # uninterruptibleMask :: ((forall a. JSM a -> JSM a) -> JSM b) -> JSM b Source # generalBracket :: JSM a -> (a -> ExitCase b -> JSM c) -> (a -> JSM b) -> JSM (b, c) Source #
MonadJSM JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> JSM a Source #
MonadRef JSM
Instance details Defined in Language.Javascript.JSaddle.Types Associated Types type Ref JSM :: Type -> Type Source # Methods newRef :: a -> JSM (Ref JSM a) Source # readRef :: Ref JSM a -> JSM a Source # writeRef :: Ref JSM a -> a -> JSM () Source # modifyRef :: Ref JSM a -> (a -> a) -> JSM () Source # modifyRef' :: Ref JSM a -> (a -> a) -> JSM () Source #
MonadAtomicRef JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods atomicModifyRef :: Ref JSM a -> (a -> (a, b)) -> JSM b Source # atomicModifyRef' :: Ref JSM a -> (a -> (a, b)) -> JSM b Source #
MonadUnliftIO JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods askUnliftIO :: JSM (UnliftIO JSM) Source # withRunInIO :: ((forall a. JSM a -> IO a) -> IO b) -> JSM b Source #
type Ref JSM
Instance details Defined in Language.Javascript.JSaddle.Types type Ref JSM = Ref IO

class (Applicative m, MonadIO m) => MonadJSM (m :: Type -> Type) Source #

The MonadJSM is to JSM what MonadIO is to IO. When using GHCJS it is MonadIO.

Instances

MonadJSM JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> JSM a Source #
MonadJSM m => MonadJSM (MaybeT m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> MaybeT m a Source #
MonadJSM m => MonadJSM (ListT m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ListT m a Source #
MonadJSM m => MonadJSM (IdentityT m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> IdentityT m a Source #
MonadJSM m => MonadJSM (ExceptT e m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ExceptT e m a Source #
(Error e, MonadJSM m) => MonadJSM (ErrorT e m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ErrorT e m a Source #
MonadJSM m => MonadJSM (StateT s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> StateT s m a Source #
MonadJSM m => MonadJSM (ReaderT r m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ReaderT r m a Source #
MonadJSM m => MonadJSM (StateT s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> StateT s m a Source #
(Monoid w, MonadJSM m) => MonadJSM (WriterT w m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> WriterT w m a Source #
(Monoid w, MonadJSM m) => MonadJSM (WriterT w m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> WriterT w m a Source #
MonadJSM m => MonadJSM (ContT r m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ContT r m a Source #
(Monoid w, MonadJSM m) => MonadJSM (RWST r w s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> RWST r w s m a Source #
(Monoid w, MonadJSM m) => MonadJSM (RWST r w s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> RWST r w s m a Source #

askJSM :: MonadJSM m => m JSContextRef Source #

Gets the JavaScript context from the monad

runJSM :: MonadIO m => JSM a -> JSContextRef -> m a Source #

Runs a JSM JavaScript function in a given JavaScript context.

class MonadIO m => MonadUnliftIO (m :: Type -> Type) where Source #

Monads which allow their actions to be run in IO.

While MonadIO allows an IO action to be lifted into another monad, this class captures the opposite concept: allowing you to capture the monadic context. Note that, in order to meet the laws given below, the intuition is that a monad must have no monadic state, but may have monadic context. This essentially limits MonadUnliftIO to ReaderT and IdentityT transformers on top of IO.

Laws. For any value u returned by askUnliftIO, it must meet the monad transformer laws as reformulated for MonadUnliftIO:

```
unliftIO u . return = return
```

unliftIO u (m >>= f) = unliftIO u m >>= unliftIO u . f

The third is a currently nameless law which ensures that the current context is preserved.

askUnliftIO >>= (u -> liftIO (unliftIO u m)) = m

If you have a name for this, please submit it in a pull request for great glory.

Since: unliftio-core-0.1.0.0

Minimal complete definition

askUnliftIO | withRunInIO

Methods

askUnliftIO :: m (UnliftIO m) Source #

Capture the current monadic context, providing the ability to run monadic actions in IO.

See UnliftIO for an explanation of why we need a helper datatype here.

Since: unliftio-core-0.1.0.0

withRunInIO :: ((forall a. m a -> IO a) -> IO b) -> m b Source #

Convenience function for capturing the monadic context and running an IO action with a runner function. The runner function is used to run a monadic action m in IO.

Since: unliftio-core-0.1.0.0

Instances

MonadUnliftIO IO
Instance details Defined in Control.Monad.IO.Unlift Methods askUnliftIO :: IO (UnliftIO IO) Source # withRunInIO :: ((forall a. IO a -> IO a) -> IO b) -> IO b Source #
MonadUnliftIO JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods askUnliftIO :: JSM (UnliftIO JSM) Source # withRunInIO :: ((forall a. JSM a -> IO a) -> IO b) -> JSM b Source #
MonadUnliftIO m => MonadUnliftIO (IdentityT m)
Instance details Defined in Control.Monad.IO.Unlift Methods askUnliftIO :: IdentityT m (UnliftIO (IdentityT m)) Source # withRunInIO :: ((forall a. IdentityT m a -> IO a) -> IO b) -> IdentityT m b Source #
MonadUnliftIO m => MonadUnliftIO (ReaderT r m)
Instance details Defined in Control.Monad.IO.Unlift Methods askUnliftIO :: ReaderT r m (UnliftIO (ReaderT r m)) Source # withRunInIO :: ((forall a. ReaderT r m a -> IO a) -> IO b) -> ReaderT r m b Source #

newtype UnliftIO (m :: Type -> Type) Source #

The ability to run any monadic action m a as IO a.

This is more precisely a natural transformation. We need to new datatype (instead of simply using a forall) due to lack of support in GHC for impredicative types.

Since: unliftio-core-0.1.0.0

Constructors

UnliftIO
Fields unliftIO :: forall a. m a -> IO a

liftJSM :: MonadJSM m => JSM a -> m a Source #

The liftJSM is to JSM what liftIO is to IO. When using GHCJS it is liftIO.

writeTVar :: TVar a -> a -> STM () Source #

Write the supplied value into a TVar.

readTVar :: TVar a -> STM a Source #

Return the current value stored in a TVar.

data STM a Source #

A monad supporting atomic memory transactions.

Instances

Monad STM	Since: base-4.3.0.0
Instance details Defined in GHC.Conc.Sync Methods (>>=) :: STM a -> (a -> STM b) -> STM b Source # (>>) :: STM a -> STM b -> STM b Source # return :: a -> STM a Source # fail :: String -> STM a Source #
Functor STM	Since: base-4.3.0.0
Instance details Defined in GHC.Conc.Sync Methods fmap :: (a -> b) -> STM a -> STM b Source # (<$) :: a -> STM b -> STM a Source #
Applicative STM	Since: base-4.8.0.0
Instance details Defined in GHC.Conc.Sync Methods pure :: a -> STM a Source # (<>) :: STM (a -> b) -> STM a -> STM b Source # liftA2 :: (a -> b -> c) -> STM a -> STM b -> STM c Source # (>) :: STM a -> STM b -> STM b Source # (<*) :: STM a -> STM b -> STM a Source #
Alternative STM	Since: base-4.8.0.0
Instance details Defined in GHC.Conc.Sync Methods empty :: STM a Source # (<\|>) :: STM a -> STM a -> STM a Source # some :: STM a -> STM [a] Source # many :: STM a -> STM [a] Source #
MonadPlus STM	Since: base-4.3.0.0
Instance details Defined in GHC.Conc.Sync Methods mzero :: STM a Source # mplus :: STM a -> STM a -> STM a Source #
MonadRef STM
Instance details Defined in Control.Monad.Ref Associated Types type Ref STM :: Type -> Type Source # Methods newRef :: a -> STM (Ref STM a) Source # readRef :: Ref STM a -> STM a Source # writeRef :: Ref STM a -> a -> STM () Source # modifyRef :: Ref STM a -> (a -> a) -> STM () Source # modifyRef' :: Ref STM a -> (a -> a) -> STM () Source #
MonadAtomicRef STM
Instance details Defined in Control.Monad.Ref Methods atomicModifyRef :: Ref STM a -> (a -> (a, b)) -> STM b Source # atomicModifyRef' :: Ref STM a -> (a -> (a, b)) -> STM b Source #
type Ref STM
Instance details Defined in Control.Monad.Ref type Ref STM = TVar

data TVar a Source #

Shared memory locations that support atomic memory transactions.

Instances

Eq (TVar a)	Since: base-4.8.0.0
Instance details Defined in GHC.Conc.Sync Methods (==) :: TVar a -> TVar a -> Bool Source # (/=) :: TVar a -> TVar a -> Bool Source #
PrimUnlifted (TVar a)	Since: primitive-0.6.4.0
Instance details Defined in Data.Primitive.UnliftedArray Methods toArrayArray# :: TVar a -> ArrayArray# Source # fromArrayArray# :: ArrayArray# -> TVar a Source #

modifyTVar :: TVar a -> (a -> a) -> STM () Source #

Mutate the contents of a TVar. N.B., this version is non-strict.

Since: stm-2.3

readTVarIO :: MonadIO m => TVar a -> m a Source #

Lifted version of readTVarIO

Since: unliftio-0.2.1.0

newTVarIO :: MonadIO m => a -> m (TVar a) Source #

Lifted version of newTVarIO

Since: unliftio-0.2.1.0

retrySTM :: STM a Source #

Renamed retry for unqualified export

Since: unliftio-0.2.1.0

atomically :: MonadIO m => STM a -> m a Source #

Lifted version of atomically

Since: unliftio-0.2.1.0