Web.Rep

A haskell library for representing web pages.

This library is a collection of web page abstractions, together with a reimagining of suavemente.

I wanted to expose the server delivery mechanism, switch the streaming nature of the gap between a web page and a haskell server, and concentrate on getting a clean interface between pure haskell and the world that is a web page.

See app/examples.hs and Examples for usage.

Shared Representation

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 Text Text -> (HashMap Text Text, Either Text 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

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 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

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

(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

type Rep a = RepF (Html ()) a

the common usage, where the representation domain is Html

oneRep :: (Monad m, MonadIO m) => Rep a -> (Rep a -> HashMap Text Text -> m ()) -> StateT (HashMap Text Text) m (HashMap Text Text, Either Text 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 Text Text) 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

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

(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

type SharedRep m a = SharedRepF m (Html ()) a

default representation type of Html ()

runOnce :: Monad m => SharedRep m a -> (Html () -> HashMap Text Text -> m ()) -> m (HashMap Text Text, Either Text a)

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

zeroState :: Monad m => SharedRep m a -> m (Html (), (HashMap Text Text, Either Text a))

compute the initial state of a SharedRep (testing)

register

Arguments

:: Monad m

=> (Text -> Either Text a)

Parser

-> (a -> Text)

Printer

-> (Text -> a -> r)

create initial object from name and initial value

-> a

initial value

-> SharedRepF m r a

Create a sharedRep

genName :: MonadState Int m => m Text

name supply for elements of a SharedRepF

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

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

Web Rep Components

data Page

Components of a web page.

A web page can take many forms but still have the same underlying representation. For example, CSS can be linked to in a separate file, or can be inline within html, but still be the same css and have the same expected external effect. A Page represents the practical components of what makes up a static snapshot of a web page.

Constructors

Page

Fields

• libsCss :: [Html ()]

  css library links

• libsJs :: [Html ()]

  javascript library links

• cssBody :: RepCss

  css

• jsGlobal :: RepJs

  javascript with global scope

• jsOnLoad :: RepJs

  javascript included within the onLoad function

• htmlHeader :: Html ()

  html within the header

• htmlBody :: Html ()

  body html

Instances

Show Page

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> Page -> ShowS

show :: Page -> String

showList :: [Page] -> ShowS

Generic Page

Defined in Web.Rep.Page

Associated Types

type Rep Page :: Type -> Type

Methods

from :: Page -> Rep Page x

to :: Rep Page x -> Page

Semigroup Page

Defined in Web.Rep.Page

Methods

(<>) :: Page -> Page -> Page

sconcat :: NonEmpty Page -> Page

stimes :: Integral b => b -> Page -> Page

Monoid Page

Defined in Web.Rep.Page

Methods

mempty :: Page

mappend :: Page -> Page -> Page

mconcat :: [Page] -> Page

type Rep Page

Defined in Web.Rep.Page

type Rep Page = D1 (MetaData "Page" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) (C1 (MetaCons "Page" PrefixI True) ((S1 (MetaSel (Just "libsCss") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Html ()]) :*: (S1 (MetaSel (Just "libsJs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Html ()]) :*: S1 (MetaSel (Just "cssBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RepCss))) :*: ((S1 (MetaSel (Just "jsGlobal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RepJs) :*: S1 (MetaSel (Just "jsOnLoad") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RepJs)) :*: (S1 (MetaSel (Just "htmlHeader") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Html ())) :*: S1 (MetaSel (Just "htmlBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Html ()))))))

data PageConfig

Configuration options when rendering a Page.

Constructors

PageConfig

Fields

• concerns :: PageConcerns
• structure :: PageStructure
• pageRender :: PageRender
• filenames :: Concerns FilePath
• localdirs :: [FilePath]

Instances

Eq PageConfig

Defined in Web.Rep.Page

Methods

(==) :: PageConfig -> PageConfig -> Bool

(/=) :: PageConfig -> PageConfig -> Bool

Show PageConfig

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageConfig -> ShowS

show :: PageConfig -> String

showList :: [PageConfig] -> ShowS

Generic PageConfig

Defined in Web.Rep.Page

Associated Types

type Rep PageConfig :: Type -> Type

Methods

from :: PageConfig -> Rep PageConfig x

to :: Rep PageConfig x -> PageConfig

type Rep PageConfig

Defined in Web.Rep.Page

type Rep PageConfig = D1 (MetaData "PageConfig" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) (C1 (MetaCons "PageConfig" PrefixI True) ((S1 (MetaSel (Just "concerns") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageConcerns) :*: S1 (MetaSel (Just "structure") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageStructure)) :*: (S1 (MetaSel (Just "pageRender") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageRender) :*: (S1 (MetaSel (Just "filenames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Concerns FilePath)) :*: S1 (MetaSel (Just "localdirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))

defaultPageConfig :: FilePath -> PageConfig

Default configuration is inline ecma and css, separate html header and body, minified code, with the suggested filename prefix.

data Concerns a

A web page typically is composed of some css, javascript and html.

Concerns abstracts this structural feature of a web page.

Constructors

Concerns

Fields

• cssConcern :: a
• jsConcern :: a
• htmlConcern :: a

Instances

Functor Concerns

Defined in Web.Rep.Page

Methods

fmap :: (a -> b) -> Concerns a -> Concerns b

(<$) :: a -> Concerns b -> Concerns a

Applicative Concerns

Defined in Web.Rep.Page

Methods

pure :: a -> Concerns a

(<*>) :: Concerns (a -> b) -> Concerns a -> Concerns b

liftA2 :: (a -> b -> c) -> Concerns a -> Concerns b -> Concerns c

(*>) :: Concerns a -> Concerns b -> Concerns b

(<*) :: Concerns a -> Concerns b -> Concerns a

Foldable Concerns

Defined in Web.Rep.Page

Methods

fold :: Monoid m => Concerns m -> m

foldMap :: Monoid m => (a -> m) -> Concerns a -> m

foldr :: (a -> b -> b) -> b -> Concerns a -> b

foldr' :: (a -> b -> b) -> b -> Concerns a -> b

foldl :: (b -> a -> b) -> b -> Concerns a -> b

foldl' :: (b -> a -> b) -> b -> Concerns a -> b

foldr1 :: (a -> a -> a) -> Concerns a -> a

foldl1 :: (a -> a -> a) -> Concerns a -> a

toList :: Concerns a -> [a]

null :: Concerns a -> Bool

length :: Concerns a -> Int

elem :: Eq a => a -> Concerns a -> Bool

maximum :: Ord a => Concerns a -> a

minimum :: Ord a => Concerns a -> a

sum :: Num a => Concerns a -> a

product :: Num a => Concerns a -> a

Traversable Concerns

Defined in Web.Rep.Page

Methods

traverse :: Applicative f => (a -> f b) -> Concerns a -> f (Concerns b)

sequenceA :: Applicative f => Concerns (f a) -> f (Concerns a)

mapM :: Monad m => (a -> m b) -> Concerns a -> m (Concerns b)

sequence :: Monad m => Concerns (m a) -> m (Concerns a)

Eq a => Eq (Concerns a)

Defined in Web.Rep.Page

Methods

(==) :: Concerns a -> Concerns a -> Bool

(/=) :: Concerns a -> Concerns a -> Bool

Show a => Show (Concerns a)

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> Concerns a -> ShowS

show :: Concerns a -> String

showList :: [Concerns a] -> ShowS

Generic (Concerns a)

Defined in Web.Rep.Page

Associated Types

type Rep (Concerns a) :: Type -> Type

Methods

from :: Concerns a -> Rep (Concerns a) x

to :: Rep (Concerns a) x -> Concerns a

type Rep (Concerns a)

Defined in Web.Rep.Page

type Rep (Concerns a) = D1 (MetaData "Concerns" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) (C1 (MetaCons "Concerns" PrefixI True) (S1 (MetaSel (Just "cssConcern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: (S1 (MetaSel (Just "jsConcern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Just "htmlConcern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))

suffixes :: Concerns FilePath

The common file suffixes of the three concerns.

concernNames :: FilePath -> FilePath -> Concerns FilePath

Create filenames for each Concern element.

data PageConcerns

Is the rendering to include all Concerns (typically in a html file) or be separated (tyypically into separate files and linked in the html file)?

Constructors

Inline

Separated

Instances

Eq PageConcerns

Defined in Web.Rep.Page

Methods

(==) :: PageConcerns -> PageConcerns -> Bool

(/=) :: PageConcerns -> PageConcerns -> Bool

Show PageConcerns

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageConcerns -> ShowS

show :: PageConcerns -> String

showList :: [PageConcerns] -> ShowS

Generic PageConcerns

Defined in Web.Rep.Page

Associated Types

type Rep PageConcerns :: Type -> Type

Methods

from :: PageConcerns -> Rep PageConcerns x

to :: Rep PageConcerns x -> PageConcerns

type Rep PageConcerns

Defined in Web.Rep.Page

type Rep PageConcerns = D1 (MetaData "PageConcerns" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) (C1 (MetaCons "Inline" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Separated" PrefixI False) (U1 :: Type -> Type))

data PageStructure

Various ways that a Html file can be structured.

Constructors

HeaderBody

Headless

Snippet

Svg

Instances

Eq PageStructure

Defined in Web.Rep.Page

Methods

(==) :: PageStructure -> PageStructure -> Bool

(/=) :: PageStructure -> PageStructure -> Bool

Show PageStructure

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageStructure -> ShowS

show :: PageStructure -> String

showList :: [PageStructure] -> ShowS

Generic PageStructure

Defined in Web.Rep.Page

Associated Types

type Rep PageStructure :: Type -> Type

Methods

from :: PageStructure -> Rep PageStructure x

to :: Rep PageStructure x -> PageStructure

type Rep PageStructure

Defined in Web.Rep.Page

type Rep PageStructure = D1 (MetaData "PageStructure" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) ((C1 (MetaCons "HeaderBody" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Headless" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Snippet" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Svg" PrefixI False) (U1 :: Type -> Type)))

data PageRender

Post-processing of page concerns

Constructors

Pretty

Minified

NoPost

Instances

Eq PageRender

Defined in Web.Rep.Page

Methods

(==) :: PageRender -> PageRender -> Bool

(/=) :: PageRender -> PageRender -> Bool

Show PageRender

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageRender -> ShowS

show :: PageRender -> String

showList :: [PageRender] -> ShowS

Generic PageRender

Defined in Web.Rep.Page

Associated Types

type Rep PageRender :: Type -> Type

Methods

from :: PageRender -> Rep PageRender x

to :: Rep PageRender x -> PageRender

type Rep PageRender

Defined in Web.Rep.Page

type Rep PageRender = D1 (MetaData "PageRender" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) (C1 (MetaCons "Pretty" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Minified" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "NoPost" PrefixI False) (U1 :: Type -> Type)))

Css

type Css = StyleM ()

The Css context is used to collect style rules which are mappings from selectors to style properties. The Css type is a computation in the StyleM monad that just collects and doesn't return anything.

data RepCss

Unifies css as either a Css or as Text.

Constructors

RepCss Css

RepCssText Text

Instances

Show RepCss

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> RepCss -> ShowS

show :: RepCss -> String

showList :: [RepCss] -> ShowS

Generic RepCss

Defined in Web.Rep.Page

Associated Types

type Rep RepCss :: Type -> Type

Methods

from :: RepCss -> Rep RepCss x

to :: Rep RepCss x -> RepCss

Semigroup RepCss

Defined in Web.Rep.Page

Methods

(<>) :: RepCss -> RepCss -> RepCss

sconcat :: NonEmpty RepCss -> RepCss

stimes :: Integral b => b -> RepCss -> RepCss

Monoid RepCss

Defined in Web.Rep.Page

Methods

mempty :: RepCss

mappend :: RepCss -> RepCss -> RepCss

mconcat :: [RepCss] -> RepCss

type Rep RepCss

Defined in Web.Rep.Page

type Rep RepCss = D1 (MetaData "RepCss" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) (C1 (MetaCons "RepCss" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Css)) :+: C1 (MetaCons "RepCssText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

renderCss :: Css -> Text

Render Css as text.

renderRepCss :: PageRender -> RepCss -> Text

Render RepCss as text.

JS

newtype JS

wrapper for JSAST

Constructors

JS

Fields

• unJS :: JSAST

Instances

Eq JS

Defined in Web.Rep.Page

Methods

(==) :: JS -> JS -> Bool

(/=) :: JS -> JS -> Bool

Show JS

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> JS -> ShowS

show :: JS -> String

showList :: [JS] -> ShowS

Generic JS

Defined in Web.Rep.Page

Associated Types

type Rep JS :: Type -> Type

Methods

from :: JS -> Rep JS x

to :: Rep JS x -> JS

Semigroup JS

Defined in Web.Rep.Page

Methods

(<>) :: JS -> JS -> JS

sconcat :: NonEmpty JS -> JS

stimes :: Integral b => b -> JS -> JS

Monoid JS

Defined in Web.Rep.Page

Methods

mempty :: JS

mappend :: JS -> JS -> JS

mconcat :: [JS] -> JS

type Rep JS

Defined in Web.Rep.Page

type Rep JS = D1 (MetaData "JS" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" True) (C1 (MetaCons "JS" PrefixI True) (S1 (MetaSel (Just "unJS") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSAST)))

data RepJs

Unifies javascript as JSStatement and script as Text.

Constructors

RepJs JS

RepJsText Text

Instances

Eq RepJs

Defined in Web.Rep.Page

Methods

(==) :: RepJs -> RepJs -> Bool

(/=) :: RepJs -> RepJs -> Bool

Show RepJs

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> RepJs -> ShowS

show :: RepJs -> String

showList :: [RepJs] -> ShowS

Generic RepJs

Defined in Web.Rep.Page

Associated Types

type Rep RepJs :: Type -> Type

Methods

from :: RepJs -> Rep RepJs x

to :: Rep RepJs x -> RepJs

Semigroup RepJs

Defined in Web.Rep.Page

Methods

(<>) :: RepJs -> RepJs -> RepJs

sconcat :: NonEmpty RepJs -> RepJs

stimes :: Integral b => b -> RepJs -> RepJs

Monoid RepJs

Defined in Web.Rep.Page

Methods

mempty :: RepJs

mappend :: RepJs -> RepJs -> RepJs

mconcat :: [RepJs] -> RepJs

type Rep RepJs

Defined in Web.Rep.Page

type Rep RepJs = D1 (MetaData "RepJs" "Web.Rep.Page" "web-rep-0.7.0-FbnLiBhVUXzFOFUBGflJ1L" False) (C1 (MetaCons "RepJs" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JS)) :+: C1 (MetaCons "RepJsText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

onLoad :: RepJs -> RepJs

Wrap js in standard DOM window loader.

renderRepJs :: PageRender -> RepJs -> Text

Render RepJs as Text.

parseJs :: Text -> JS

Convert Text to JS, throwing an error on incorrectness.

renderJs :: JS -> Text

Render JS as Text.

re-export modules

module Web.Rep.SharedReps

module Web.Rep.Render

module Web.Rep.Server

module Web.Rep.Socket

module Web.Rep.Html

module Web.Rep.Html.Input

module Web.Rep.Bootstrap

module Web.Rep.Mathjax

re-exports

data HashMap k v

A map from keys to values. A map cannot contain duplicate keys; each key can map to at most one value.

Instances

Bifoldable HashMap

Since: unordered-containers-0.2.11

Defined in Data.HashMap.Internal

Methods

bifold :: Monoid m => HashMap m m -> m

bifoldMap :: Monoid m => (a -> m) -> (b -> m) -> HashMap a b -> m

bifoldr :: (a -> c -> c) -> (b -> c -> c) -> c -> HashMap a b -> c

bifoldl :: (c -> a -> c) -> (c -> b -> c) -> c -> HashMap a b -> c

Eq2 HashMap

Defined in Data.HashMap.Internal

Methods

liftEq2 :: (a -> b -> Bool) -> (c -> d -> Bool) -> HashMap a c -> HashMap b d -> Bool

Ord2 HashMap

Defined in Data.HashMap.Internal

Methods

liftCompare2 :: (a -> b -> Ordering) -> (c -> d -> Ordering) -> HashMap a c -> HashMap b d -> Ordering

Show2 HashMap

Defined in Data.HashMap.Internal

Methods

liftShowsPrec2 :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> (Int -> b -> ShowS) -> ([b] -> ShowS) -> Int -> HashMap a b -> ShowS

liftShowList2 :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> (Int -> b -> ShowS) -> ([b] -> ShowS) -> [HashMap a b] -> ShowS

Hashable2 HashMap

Defined in Data.HashMap.Internal

Methods

liftHashWithSalt2 :: (Int -> a -> Int) -> (Int -> b -> Int) -> Int -> HashMap a b -> Int

FunctorWithIndex k (HashMap k)

Defined in Control.Lens.Indexed

Methods

imap :: (k -> a -> b) -> HashMap k a -> HashMap k b

imapped :: IndexedSetter k (HashMap k a) (HashMap k b) a b

FoldableWithIndex k (HashMap k)

Defined in Control.Lens.Indexed

Methods

ifoldMap :: Monoid m => (k -> a -> m) -> HashMap k a -> m

ifolded :: IndexedFold k (HashMap k a) a

ifoldr :: (k -> a -> b -> b) -> b -> HashMap k a -> b

ifoldl :: (k -> b -> a -> b) -> b -> HashMap k a -> b

ifoldr' :: (k -> a -> b -> b) -> b -> HashMap k a -> b

ifoldl' :: (k -> b -> a -> b) -> b -> HashMap k a -> b

TraversableWithIndex k (HashMap k)

Defined in Control.Lens.Indexed

Methods

itraverse :: Applicative f => (k -> a -> f b) -> HashMap k a -> f (HashMap k b)

itraversed :: IndexedTraversal k (HashMap k a) (HashMap k b) a b

Functor (HashMap k)

Defined in Data.HashMap.Internal

Methods

fmap :: (a -> b) -> HashMap k a -> HashMap k b

(<$) :: a -> HashMap k b -> HashMap k a

Foldable (HashMap k)

Defined in Data.HashMap.Internal

Methods

fold :: Monoid m => HashMap k m -> m

foldMap :: Monoid m => (a -> m) -> HashMap k a -> m

foldr :: (a -> b -> b) -> b -> HashMap k a -> b

foldr' :: (a -> b -> b) -> b -> HashMap k a -> b

foldl :: (b -> a -> b) -> b -> HashMap k a -> b

foldl' :: (b -> a -> b) -> b -> HashMap k a -> b

foldr1 :: (a -> a -> a) -> HashMap k a -> a

foldl1 :: (a -> a -> a) -> HashMap k a -> a

toList :: HashMap k a -> [a]

null :: HashMap k a -> Bool

length :: HashMap k a -> Int

elem :: Eq a => a -> HashMap k a -> Bool

maximum :: Ord a => HashMap k a -> a

minimum :: Ord a => HashMap k a -> a

sum :: Num a => HashMap k a -> a

product :: Num a => HashMap k a -> a

Traversable (HashMap k)

Defined in Data.HashMap.Internal

Methods

traverse :: Applicative f => (a -> f b) -> HashMap k a -> f (HashMap k b)

sequenceA :: Applicative f => HashMap k (f a) -> f (HashMap k a)

mapM :: Monad m => (a -> m b) -> HashMap k a -> m (HashMap k b)

sequence :: Monad m => HashMap k (m a) -> m (HashMap k a)

Eq k => Eq1 (HashMap k)

Defined in Data.HashMap.Internal

Methods

liftEq :: (a -> b -> Bool) -> HashMap k a -> HashMap k b -> Bool

Ord k => Ord1 (HashMap k)

Defined in Data.HashMap.Internal

Methods

liftCompare :: (a -> b -> Ordering) -> HashMap k a -> HashMap k b -> Ordering

(Eq k, Hashable k, Read k) => Read1 (HashMap k)

Defined in Data.HashMap.Internal

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (HashMap k a)

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [HashMap k a]

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (HashMap k a)

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [HashMap k a]

Show k => Show1 (HashMap k)

Defined in Data.HashMap.Internal

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> HashMap k a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [HashMap k a] -> ShowS

Hashable k => Hashable1 (HashMap k)

Defined in Data.HashMap.Internal

Methods

liftHashWithSalt :: (Int -> a -> Int) -> Int -> HashMap k a -> Int

(Eq k, Hashable k) => IsList (HashMap k v)

Defined in Data.HashMap.Internal

Associated Types

type Item (HashMap k v) :: Type

Methods

fromList :: [Item (HashMap k v)] -> HashMap k v

fromListN :: Int -> [Item (HashMap k v)] -> HashMap k v

toList :: HashMap k v -> [Item (HashMap k v)]

(Eq k, Eq v) => Eq (HashMap k v)

Note that, in the presence of hash collisions, equal HashMaps may behave differently, i.e. substitutivity may be violated:

>>> data D = A | B deriving (Eq, Show)
>>> instance Hashable D where hashWithSalt salt _d = salt

>>> x = fromList [(A,1), (B,2)]
>>> y = fromList [(B,2), (A,1)]

>>> x == y
True
>>> toList x
[(A,1),(B,2)]
>>> toList y
[(B,2),(A,1)]

In general, the lack of substitutivity can be observed with any function that depends on the key ordering, such as folds and traversals.

Defined in Data.HashMap.Internal

Methods

(==) :: HashMap k v -> HashMap k v -> Bool

(/=) :: HashMap k v -> HashMap k v -> Bool

(Data k, Data v, Eq k, Hashable k) => Data (HashMap k v)

Defined in Data.HashMap.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HashMap k v -> c (HashMap k v)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (HashMap k v)

toConstr :: HashMap k v -> Constr

dataTypeOf :: HashMap k v -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (HashMap k v))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (HashMap k v))

gmapT :: (forall b. Data b => b -> b) -> HashMap k v -> HashMap k v

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HashMap k v -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HashMap k v -> r

gmapQ :: (forall d. Data d => d -> u) -> HashMap k v -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> HashMap k v -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> HashMap k v -> m (HashMap k v)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HashMap k v -> m (HashMap k v)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HashMap k v -> m (HashMap k v)

(Ord k, Ord v) => Ord (HashMap k v)

The ordering is total and consistent with the Eq instance. However, nothing else about the ordering is specified, and it may change from version to version of either this package or of hashable.

Defined in Data.HashMap.Internal

Methods

compare :: HashMap k v -> HashMap k v -> Ordering

(<) :: HashMap k v -> HashMap k v -> Bool

(<=) :: HashMap k v -> HashMap k v -> Bool

(>) :: HashMap k v -> HashMap k v -> Bool

(>=) :: HashMap k v -> HashMap k v -> Bool

max :: HashMap k v -> HashMap k v -> HashMap k v

min :: HashMap k v -> HashMap k v -> HashMap k v

(Eq k, Hashable k, Read k, Read e) => Read (HashMap k e)

Defined in Data.HashMap.Internal

Methods

readsPrec :: Int -> ReadS (HashMap k e)

readList :: ReadS [HashMap k e]

readPrec :: ReadPrec (HashMap k e)

readListPrec :: ReadPrec [HashMap k e]

(Show k, Show v) => Show (HashMap k v)

Defined in Data.HashMap.Internal

Methods

showsPrec :: Int -> HashMap k v -> ShowS

show :: HashMap k v -> String

showList :: [HashMap k v] -> ShowS

(Eq k, Hashable k) => Semigroup (HashMap k v)

<> = union

If a key occurs in both maps, the mapping from the first will be the mapping in the result.

Examples

>>> fromList [(1,'a'),(2,'b')] <> fromList [(2,'c'),(3,'d')]
fromList [(1,'a'),(2,'b'),(3,'d')]

Defined in Data.HashMap.Internal

Methods

(<>) :: HashMap k v -> HashMap k v -> HashMap k v

sconcat :: NonEmpty (HashMap k v) -> HashMap k v

stimes :: Integral b => b -> HashMap k v -> HashMap k v

(Eq k, Hashable k) => Monoid (HashMap k v)

mempty = empty

mappend = union

If a key occurs in both maps, the mapping from the first will be the mapping in the result.

Examples

>>> mappend (fromList [(1,'a'),(2,'b')]) (fromList [(2,'c'),(3,'d')])
fromList [(1,'a'),(2,'b'),(3,'d')]

Defined in Data.HashMap.Internal

Methods

mempty :: HashMap k v

mappend :: HashMap k v -> HashMap k v -> HashMap k v

mconcat :: [HashMap k v] -> HashMap k v

(Hashable k, Hashable v) => Hashable (HashMap k v)

Defined in Data.HashMap.Internal

Methods

hashWithSalt :: Int -> HashMap k v -> Int

hash :: HashMap k v -> Int

(NFData k, NFData v) => NFData (HashMap k v)

Defined in Data.HashMap.Internal

Methods

rnf :: HashMap k v -> ()

(Eq k, Hashable k) => Ixed (HashMap k a)

Defined in Control.Lens.At

Methods

ix :: Index (HashMap k a) -> Traversal' (HashMap k a) (IxValue (HashMap k a))

(Eq k, Hashable k) => At (HashMap k a)

Defined in Control.Lens.At

Methods

at :: Index (HashMap k a) -> Lens' (HashMap k a) (Maybe (IxValue (HashMap k a)))

(Hashable k, Eq k) => Wrapped (HashMap k a)

Defined in Control.Lens.Wrapped

Associated Types

type Unwrapped (HashMap k a) :: Type

Methods

_Wrapped' :: Iso' (HashMap k a) (Unwrapped (HashMap k a))

AsEmpty (HashMap k a)

Defined in Control.Lens.Empty

Methods

_Empty :: Prism' (HashMap k a) ()

(t ~ HashMap k' a', Hashable k, Eq k) => Rewrapped (HashMap k a) t

Use wrapping fromList. Unwrapping returns some permutation of the list.

Defined in Control.Lens.Wrapped

c ~ d => Each (HashMap c a) (HashMap d b) a b

each :: Traversal (HashMap c a) (HashMap c b) a b

Defined in Control.Lens.Each

Methods

each :: Traversal (HashMap c a) (HashMap d b) a b

type Item (HashMap k v)

Defined in Data.HashMap.Internal

type Item (HashMap k v) = (k, v)

type Index (HashMap k a)

Defined in Control.Lens.At

type Index (HashMap k a) = k

type IxValue (HashMap k a)

Defined in Control.Lens.At

type IxValue (HashMap k a) = a

type Unwrapped (HashMap k a)

Defined in Control.Lens.Wrapped

type Unwrapped (HashMap k a) = [(k, a)]