Ema.Route.Class

Documentation

class IsRoute r where

Class of Ema routes

An Ema route has a Prism' routePrism, that knows how to convert it to/from filepaths. As well as an universe function, routeUniverse, that gives all possible route values in a static site.

Both functions take the associated model, `RouteModel r`, as an argument.

Associated Types

type RouteModel r :: Type

Methods

routePrism :: RouteModel r -> Prism_ FilePath r

An optics Prism` that denotes how to encode and decode a route.

routeUniverse :: RouteModel r -> [r]

All possible route values for the given RouteModel.

This is used in determining the pages to statically generate.

Instances

IsRoute PandocRoute

Defined in Ema.Route.Lib.Extra.PandocRoute

Associated Types

type RouteModel PandocRoute

Methods

routePrism :: RouteModel PandocRoute -> Prism_ FilePath PandocRoute

routeUniverse :: RouteModel PandocRoute -> [PandocRoute]

IsRoute ()

Defined in Ema.Route.Class

Associated Types

type RouteModel ()

Methods

routePrism :: RouteModel () -> Prism_ FilePath ()

routeUniverse :: RouteModel () -> [()]

IsRoute (SlugRoute a)

Defined in Ema.Route.Lib.Extra.SlugRoute

Associated Types

type RouteModel (SlugRoute a)

Methods

routePrism :: RouteModel (SlugRoute a) -> Prism_ FilePath (SlugRoute a)

routeUniverse :: RouteModel (SlugRoute a) -> [SlugRoute a]

IsRoute (StaticRoute baseDir)

Defined in Ema.Route.Lib.Extra.StaticRoute

Associated Types

type RouteModel (StaticRoute baseDir)

Methods

routePrism :: RouteModel (StaticRoute baseDir) -> Prism_ FilePath (StaticRoute baseDir)

routeUniverse :: RouteModel (StaticRoute baseDir) -> [StaticRoute baseDir]

KnownSymbol fn => IsRoute (FileRoute fn)

Defined in Ema.Route.Lib.File

Associated Types

type RouteModel (FileRoute fn)

Methods

routePrism :: RouteModel (FileRoute fn) -> Prism_ FilePath (FileRoute fn)

routeUniverse :: RouteModel (FileRoute fn) -> [FileRoute fn]

(IsRoute r, IsRoute (MultiRoute rs), RouteModel (MultiRoute rs) ~ NP I (MultiModel rs)) => IsRoute (MultiRoute (r ': rs))

Defined in Ema.Route.Lib.Multi

Associated Types

type RouteModel (MultiRoute (r ': rs))

Methods

routePrism :: RouteModel (MultiRoute (r ': rs)) -> Prism_ FilePath (MultiRoute (r ': rs))

routeUniverse :: RouteModel (MultiRoute (r ': rs)) -> [MultiRoute (r ': rs)]

IsRoute (MultiRoute ('[] :: [Type]))

Defined in Ema.Route.Lib.Multi

Associated Types

type RouteModel (MultiRoute '[])

Methods

routePrism :: RouteModel (MultiRoute '[]) -> Prism_ FilePath (MultiRoute '[])

routeUniverse :: RouteModel (MultiRoute '[]) -> [MultiRoute '[]]

(VerifyRoutes (RCode r) (SubRoutes (GenericRoute r opts)), HasSubRoutes r, HasSubModels r, ValidSubRoutes r (SubRoutes r), RGeneric r, mr ~ MultiRoute (SubRoutes r), mm ~ MultiModel (SubRoutes r), RouteModel r ~ OptModel r opts, RouteModel mr ~ NP I mm, IsRoute mr, GenericRouteOpts r opts) => IsRoute (GenericRoute r opts)

Defined in Ema.Route.Generic

Associated Types

type RouteModel (GenericRoute r opts)

Methods

routePrism :: RouteModel (GenericRoute r opts) -> Prism_ FilePath (GenericRoute r opts)

routeUniverse :: RouteModel (GenericRoute r opts) -> [GenericRoute r opts]

(IsRoute r, KnownSymbol prefix) => IsRoute (FolderRoute prefix r)

Defined in Ema.Route.Lib.Folder

Associated Types

type RouteModel (FolderRoute prefix r)

Methods

routePrism :: RouteModel (FolderRoute prefix r) -> Prism_ FilePath (FolderRoute prefix r)

routeUniverse :: RouteModel (FolderRoute prefix r) -> [FolderRoute prefix r]