Ema

Documentation

data Format

Constructors

Html

Other

Instances

Eq Format

Defined in Ema.Asset

Methods

(==) :: Format -> Format -> Bool

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

Ord Format

Defined in Ema.Asset

Methods

compare :: Format -> Format -> Ordering

(<) :: Format -> Format -> Bool

(<=) :: Format -> Format -> Bool

(>) :: Format -> Format -> Bool

(>=) :: Format -> Format -> Bool

max :: Format -> Format -> Format

min :: Format -> Format -> Format

Show Format

Defined in Ema.Asset

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

Generic Format

Defined in Ema.Asset

Associated Types

type Rep Format :: Type -> Type

Methods

from :: Format -> Rep Format x

to :: Rep Format x -> Format

type Rep Format

Defined in Ema.Asset

type Rep Format = D1 ('MetaData "Format" "Ema.Asset" "ema-0.6.0.0-Gf9N5ZNZjTx7iyuu6ZTKHB" 'False) (C1 ('MetaCons "Html" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Other" 'PrefixI 'False) (U1 :: Type -> Type))

data Asset a

The type of assets that can be bundled in a static site.

Constructors

AssetStatic FilePath

A file that is copied as-is from the source directory.

Relative paths are assumed relative to the source directory. Absolute paths allow copying static files outside of source directory.

AssetGenerated Format a

A file whose contents are generated at runtime by user code.

Instances

Eq a => Eq (Asset a)

Defined in Ema.Asset

Methods

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

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

Ord a => Ord (Asset a)

Defined in Ema.Asset

Methods

compare :: Asset a -> Asset a -> Ordering

(<) :: Asset a -> Asset a -> Bool

(<=) :: Asset a -> Asset a -> Bool

(>) :: Asset a -> Asset a -> Bool

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

max :: Asset a -> Asset a -> Asset a

min :: Asset a -> Asset a -> Asset a

Show a => Show (Asset a)

Defined in Ema.Asset

Methods

showsPrec :: Int -> Asset a -> ShowS

show :: Asset a -> String

showList :: [Asset a] -> ShowS

Generic (Asset a)

Defined in Ema.Asset

Associated Types

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

Methods

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

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

type Rep (Asset a)

Defined in Ema.Asset

type Rep (Asset a) = D1 ('MetaData "Asset" "Ema.Asset" "ema-0.6.0.0-Gf9N5ZNZjTx7iyuu6ZTKHB" 'False) (C1 ('MetaCons "AssetStatic" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "AssetGenerated" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Format) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

class Ema model route | route -> model where

Enrich a model to work with Ema

Minimal complete definition

encodeRoute, decodeRoute

Methods

encodeRoute :: model -> route -> FilePath

Get the filepath on disk corresponding to this route.

decodeRoute :: model -> FilePath -> Maybe route

Decode a filepath on disk into a route.

allRoutes :: model -> [route]

All routes in the site

The gen command will generate only these routes. On live server, this function is never used.

default allRoutes :: (Bounded route, Enum route) => model -> [route]

Instances

Ema () ()

The unit model is useful when using Ema in pure fashion (see Ema.runEmaPure) with a single route (index.html) only.

Defined in Ema.Class

Methods

encodeRoute :: () -> () -> FilePath

decodeRoute :: () -> FilePath -> Maybe ()

allRoutes :: () -> [()]

data UrlStrategy

Constructors

UrlPretty

UrlDirect

Instances

Eq UrlStrategy

Defined in Ema.Route

Methods

(==) :: UrlStrategy -> UrlStrategy -> Bool

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

Ord UrlStrategy

Defined in Ema.Route

Methods

compare :: UrlStrategy -> UrlStrategy -> Ordering

(<) :: UrlStrategy -> UrlStrategy -> Bool

(<=) :: UrlStrategy -> UrlStrategy -> Bool

(>) :: UrlStrategy -> UrlStrategy -> Bool

(>=) :: UrlStrategy -> UrlStrategy -> Bool

max :: UrlStrategy -> UrlStrategy -> UrlStrategy

min :: UrlStrategy -> UrlStrategy -> UrlStrategy

Show UrlStrategy

Defined in Ema.Route

Methods

showsPrec :: Int -> UrlStrategy -> ShowS

show :: UrlStrategy -> String

showList :: [UrlStrategy] -> ShowS

FromJSON UrlStrategy

Defined in Ema.Route

Methods

parseJSON :: Value -> Parser UrlStrategy

parseJSONList :: Value -> Parser [UrlStrategy]

routeUrlWith :: forall r model. Ema model r => UrlStrategy -> model -> r -> Text

Return the relative URL of the given route

As the returned URL is relative, you will have to either make it absolute (by prepending with /) or set the `base` URL in your HTML head element.

routeUrl :: forall r model. Ema model r => model -> r -> Text

emaErrorHtmlResponse :: Text -> LByteString

A basic error response for displaying in the browser

runEmaPure

Arguments

:: (Some Action -> LByteString)

How to render a route

-> IO ()

Pure version of runEmaWith (i.e with no model).

Due to purity, there is no impure state, and thus no time-varying model. Neither is there a concept of route, as only a single route (index.html) is expected, whose HTML contents is specified as the only argument to this function.

runEma

Arguments

:: forall model route b. (Ema model route, Show route)

=> (Some Action -> model -> route -> Asset LByteString)

How to render a route, given the model

-> (forall m. (MonadIO m, MonadUnliftIO m, MonadLoggerIO m) => Some Action -> LVar model -> m b)

A long-running IO action that will update the model LVar over time. This IO action must set the initial model value in the very beginning.

-> IO (Either b (DSum Action Identity))

Convenient version of runEmaWith that takes initial model and an update function. You typically want to use this.

It uses race_ to properly clean up the update action when the ema thread exits, and vice-versa.

runEmaWithCli

Arguments

:: forall model route b. (Ema model route, Show route)

=> Cli

-> (Some Action -> model -> route -> Asset LByteString)

How to render a route, given the model

-> (forall m. (MonadIO m, MonadUnliftIO m, MonadLoggerIO m) => Some Action -> LVar model -> m b)

A long-running IO action that will update the model LVar over time. This IO action must set the initial model value in the very beginning.

-> IO (Either b (DSum Action Identity))

Like runEma but takes the CLI action

Useful if you are handling CLI arguments yourself.