Web.Rep.Shared

A shared-element representation of web page communication.

Documentation

data RepF r a

Information contained in a web page can usually be considered to be isomorphic to a map of named values - a HashMap. This is especially true when considering a differential of information contained in a web page. Looking at a page from the outside, it often looks like a streaming differential of a hashmap.

RepF consists of an underlying value being represented, and, given a hashmap state, a way to produce a representation of the underlying value (or error), in another domain, together with the potential to alter the hashmap state.

Constructors

Rep

Fields

• rep :: r
• make :: HashMap ByteString ByteString -> (HashMap ByteString ByteString, Either ByteString a)

Instances

Bifunctor RepF

Defined in Web.Rep.Shared

Methods

bimap :: (a -> b) -> (c -> d) -> RepF a c -> RepF b d

first :: (a -> b) -> RepF a c -> RepF b c

second :: (b -> c) -> RepF a b -> RepF a c

Biapplicative RepF

Defined in Web.Rep.Shared

Methods

bipure :: a -> b -> RepF a b

(<<*>>) :: RepF (a -> b) (c -> d) -> RepF a c -> RepF b d

biliftA2 :: (a -> b -> c) -> (d -> e -> f) -> RepF a d -> RepF b e -> RepF c f

(*>>) :: RepF a b -> RepF c d -> RepF c d

(<<*) :: RepF a b -> RepF c d -> RepF a b

Monoid r => Applicative (RepF r)

Defined in Web.Rep.Shared

Methods

pure :: a -> RepF r a

(<*>) :: RepF r (a -> b) -> RepF r a -> RepF r b

liftA2 :: (a -> b -> c) -> RepF r a -> RepF r b -> RepF r c

(*>) :: RepF r a -> RepF r b -> RepF r b

(<*) :: RepF r a -> RepF r b -> RepF r a

Functor (RepF r)

Defined in Web.Rep.Shared

Methods

fmap :: (a -> b) -> RepF r a -> RepF r b

(<$) :: a -> RepF r b -> RepF r a

(Monoid a, Monoid r) => Monoid (RepF r a)

Defined in Web.Rep.Shared

Methods

mempty :: RepF r a

mappend :: RepF r a -> RepF r a -> RepF r a

mconcat :: [RepF r a] -> RepF r a

Semigroup r => Semigroup (RepF r a)

Defined in Web.Rep.Shared

Methods

(<>) :: RepF r a -> RepF r a -> RepF r a

sconcat :: NonEmpty (RepF r a) -> RepF r a

stimes :: Integral b => b -> RepF r a -> RepF r a

type Rep a = RepF Markup a

the common usage, where the representation domain is Html

oneRep :: Monad m => Rep a -> (Rep a -> HashMap ByteString ByteString -> m ()) -> StateT (HashMap ByteString ByteString) m (HashMap ByteString ByteString, Either ByteString a)

stateful result of one step, given a RepF, and a monadic action. Useful for testing and for initialising a page.

newtype SharedRepF m r a

Driven by the architecture of the DOM, web page components are compositional, and tree-like, where components are often composed of other components, and values are thus shared across components.

This is sometimes referred to as "observable sharing". See data-reify as another library that reifies this (pun intended), and provided the initial inspiration for this implementation.

unshare should only be run once, which is a terrible flaw that might be fixed by linear types.

Constructors

SharedRep

Fields

• unshare :: StateT (Int, HashMap ByteString ByteString) m (RepF r a)

Instances

Functor m => Bifunctor (SharedRepF m)

Defined in Web.Rep.Shared

Methods

bimap :: (a -> b) -> (c -> d) -> SharedRepF m a c -> SharedRepF m b d

first :: (a -> b) -> SharedRepF m a c -> SharedRepF m b c

second :: (b -> c) -> SharedRepF m a b -> SharedRepF m a c

Monad m => Biapplicative (SharedRepF m)

Defined in Web.Rep.Shared

Methods

bipure :: a -> b -> SharedRepF m a b

(<<*>>) :: SharedRepF m (a -> b) (c -> d) -> SharedRepF m a c -> SharedRepF m b d

biliftA2 :: (a -> b -> c) -> (d -> e -> f) -> SharedRepF m a d -> SharedRepF m b e -> SharedRepF m c f

(*>>) :: SharedRepF m a b -> SharedRepF m c d -> SharedRepF m c d

(<<*) :: SharedRepF m a b -> SharedRepF m c d -> SharedRepF m a b

(Monad m, Monoid r) => Applicative (SharedRepF m r)

Defined in Web.Rep.Shared

Methods

pure :: a -> SharedRepF m r a

(<*>) :: SharedRepF m r (a -> b) -> SharedRepF m r a -> SharedRepF m r b

liftA2 :: (a -> b -> c) -> SharedRepF m r a -> SharedRepF m r b -> SharedRepF m r c

(*>) :: SharedRepF m r a -> SharedRepF m r b -> SharedRepF m r b

(<*) :: SharedRepF m r a -> SharedRepF m r b -> SharedRepF m r a

Functor m => Functor (SharedRepF m r)

Defined in Web.Rep.Shared

Methods

fmap :: (a -> b) -> SharedRepF m r a -> SharedRepF m r b

(<$) :: a -> SharedRepF m r b -> SharedRepF m r a

type SharedRep m a = SharedRepF m Markup a

default representation type of Html ()

runOnce :: Monad m => SharedRep m a -> (Markup -> HashMap ByteString ByteString -> m ()) -> m (HashMap ByteString ByteString, Either ByteString a)

Compute the initial state of a SharedRep and then run an action once (see tests).

zeroState :: Monad m => SharedRep m a -> m (Markup, (HashMap ByteString ByteString, Either ByteString a))

compute the initial state of a SharedRep (testing)

register

Arguments

:: Monad m

=> (ByteString -> Either ByteString a)

Parser

-> (a -> ByteString)

Printer

-> (ByteString -> a -> r)

create initial object from name and initial value

-> a

initial value

-> SharedRepF m r a

Create a sharedRep

message

Arguments

:: Monad m

=> (ByteString -> Either ByteString a)

Parser

-> (ByteString -> a -> r)

create initial object from name and initial value

-> a

initial value

-> a

default value

-> SharedRepF m r a

Like register, but does not put a value into the HashMap on instantiation, consumes the value when found in the HashMap, and substitutes a default on lookup failure

genName :: MonadState Int m => m ByteString

name supply for elements of a SharedRepF

genNamePre :: MonadState Int m => ByteString -> m ByteString

sometimes a number doesn't work properly in html (or js???), and an alpha prefix seems to help