Modulemiso-1.12.0.0

Miso.Router

Synopsis

value capture
value fragment
value lexTokens
value parseURI
value path
value queryFlag
value queryParam
value routes
value runRouter
value toCapture
value toPath
value toQueryParam
value tokensToURI
value emptyURI
value prettyQueryString
value prettyURI
newtype Capture
data Fragment
class GRouter
newtype Path
newtype QueryFlag
newtype QueryParam
type RouteParser
class Router
data RoutingError
data Token
data URI

Packagemiso-1.12.0.0
Exports27
LicenceBSD-3-Clause

valuecapture :: FromMisoString value => RouteParser value

valuefragment :: MisoString -> RouteParser MisoString

valuelexTokens :: MisoString -> Either LexerError [Token]

valueparseURI :: MisoString -> Either MisoString URI

valuepath :: MisoString -> RouteParser MisoString

valuequeryFlag :: KnownSymbol flag => RouteParser (QueryFlag flag)

valuequeryParam :: (FromMisoString a, KnownSymbol param) => RouteParser (QueryParam param a)

valueroutes :: [RouteParser route] -> RouteParser route

valuerunRouter :: MisoString -> RouteParser route -> Either RoutingError route

valuetoCapture :: ToMisoString string => string -> Token

valuetoPath :: MisoString -> Token

valuetoQueryParam :: ToMisoString s => MisoString -> s -> Token

valuetokensToURI :: [Token] -> URI

valueemptyURI :: URI

valueprettyQueryString :: URI -> MisoString

valueprettyURI :: URI -> MisoString

newtypenewtype Capture (sym :: k) a

Constructors

Capture a

Instances5GRouter, Eq, Show, ToMisoString, FromMisoString

(FromMisoString a, ToMisoString a) => GRouter (K1 m (Capture sym a))Defined in miso-1.12.0.0 · Miso.Router
Eq a => Eq (Capture sym a)Defined in miso-1.12.0.0 · Miso.Router
Show a => Show (Capture sym a)Defined in miso-1.12.0.0 · Miso.Router
ToMisoString a => ToMisoString (Capture sym a)Defined in miso-1.12.0.0 · Miso.Router
FromMisoString a => FromMisoString (Capture sym a)Defined in miso-1.12.0.0 · Miso.Router

datadata Fragment (path :: Symbol)

Fragment

Instances4GRouter, Eq, Show, ToMisoString

KnownSymbol frag => GRouter (K1 m (Fragment frag))Defined in miso-1.12.0.0 · Miso.Router
Eq (Fragment path)Defined in miso-1.12.0.0 · Miso.Router
Show (Fragment path)Defined in miso-1.12.0.0 · Miso.Router
KnownSymbol frag => ToMisoString (Fragment frag)Defined in miso-1.12.0.0 · Miso.Router

classclass GRouter (f :: k -> Type) where

Methods

gFromRoute :: f route -> [Token]
gRouteParser :: RouteParser (f route)

Instances12GRouter, …

GRouter U1Defined in miso-1.12.0.0 · Miso.Router
KnownSymbol flag => GRouter (K1 m (QueryFlag flag))Defined in miso-1.12.0.0 · Miso.Router
KnownSymbol frag => GRouter (K1 m (Fragment frag))Defined in miso-1.12.0.0 · Miso.Router
KnownSymbol path => GRouter (K1 m (Path path))Defined in miso-1.12.0.0 · Miso.Router
GRouter next => GRouter (D1 m next)Defined in miso-1.12.0.0 · Miso.Router
GRouter next => GRouter (S1 m next)Defined in miso-1.12.0.0 · Miso.Router
Router a => GRouter (K1 m a)Defined in miso-1.12.0.0 · Miso.Router
(KnownSymbol name, GRouter next) => GRouter (C1 ('MetaCons name x y) next)Defined in miso-1.12.0.0 · Miso.Router
(GRouter left, GRouter right) => GRouter (left :*: right)Defined in miso-1.12.0.0 · Miso.Router
(GRouter left, GRouter right) => GRouter (left :+: right)Defined in miso-1.12.0.0 · Miso.Router
(FromMisoString a, ToMisoString a) => GRouter (K1 m (Capture sym a))Defined in miso-1.12.0.0 · Miso.Router
(ToMisoString a, FromMisoString a, KnownSymbol param) => GRouter (K1 m (QueryParam param a))Defined in miso-1.12.0.0 · Miso.Router

newtypenewtype Path (path :: Symbol)

Constructors

Path MisoString

Instances5GRouter, Eq, Show, IsString, ToMisoString

KnownSymbol path => GRouter (K1 m (Path path))Defined in miso-1.12.0.0 · Miso.Router
Eq (Path path)Defined in miso-1.12.0.0 · Miso.Router
Show (Path path)Defined in miso-1.12.0.0 · Miso.Router
IsString (Path path)Defined in miso-1.12.0.0 · Miso.Router
ToMisoString (Path path)Defined in miso-1.12.0.0 · Miso.Router

newtypenewtype QueryFlag (path :: Symbol)

Constructors

QueryFlag Bool

Instances4GRouter, Eq, Show, ToMisoString

KnownSymbol flag => GRouter (K1 m (QueryFlag flag))Defined in miso-1.12.0.0 · Miso.Router
Eq (QueryFlag path)Defined in miso-1.12.0.0 · Miso.Router
Show (QueryFlag path)Defined in miso-1.12.0.0 · Miso.Router
KnownSymbol name => ToMisoString (QueryFlag name)Defined in miso-1.12.0.0 · Miso.Router

newtypenewtype QueryParam (path :: Symbol) a

Constructors

QueryParam (Maybe a)

Instances5GRouter, Eq, Show, ToMisoString, FromMisoString

(ToMisoString a, FromMisoString a, KnownSymbol param) => GRouter (K1 m (QueryParam param a))Defined in miso-1.12.0.0 · Miso.Router
Eq a => Eq (QueryParam path a)Defined in miso-1.12.0.0 · Miso.Router
Show a => Show (QueryParam path a)Defined in miso-1.12.0.0 · Miso.Router
(ToMisoString a, KnownSymbol path) => ToMisoString (QueryParam path a)Defined in miso-1.12.0.0 · Miso.Router
(FromMisoString a, KnownSymbol path) => FromMisoString (QueryParam path a)Defined in miso-1.12.0.0 · Miso.Router

typetype RouteParser = ParserT URI [Token] []

classclass Router route where

Methods

fromRoute :: route -> [Token]
toURI :: route -> URI
route :: URI -> Either RoutingError route
href_ :: route -> Attribute action
prettyRoute :: route -> MisoString
dumpURI :: route -> MisoString
toRoute :: MisoString -> Either RoutingError route
routeParser :: RouteParser route

datadata RoutingError

Constructors

Instances2Eq, Show

Eq RoutingErrorDefined in miso-1.12.0.0 · Miso.Router
Show RoutingErrorDefined in miso-1.12.0.0 · Miso.Router

datadata Token

Constructors

QueryParamTokens [(MisoString, Maybe MisoString)]
QueryParamToken MisoString (Maybe MisoString)
CaptureOrPathToken MisoString
FragmentToken MisoString
IndexToken

Instances3Eq, Show, ToMisoString

Eq TokenDefined in miso-1.12.0.0 · Miso.Router
Show TokenDefined in miso-1.12.0.0 · Miso.Router
ToMisoString TokenDefined in miso-1.12.0.0 · Miso.Router

datadata URI

Constructors

URI
- uriPath :: MisoString
- uriFragment :: MisoString
- uriQueryString :: Map MisoString (Maybe MisoString)

Instances10Eq, Show, Generic, ToJSVal, ToObject, ToMisoString, …

Eq URIDefined in miso-1.12.0.0 · Miso.Types
Show URIDefined in miso-1.12.0.0 · Miso.Types
Generic URIDefined in miso-1.12.0.0 · Miso.Types
ToJSVal URIDefined in miso-1.12.0.0 · Miso.Types
ToObject URIDefined in miso-1.12.0.0 · Miso.Types
ToMisoString URIDefined in miso-1.12.0.0 · Miso.Types
FromJSON URIDefined in miso-1.12.0.0 · Miso.Router · orphan
ToJSON URIDefined in miso-1.12.0.0 · Miso.Types
FromMisoString URIDefined in miso-1.12.0.0 · Miso.Router · orphan
type Rep URI = D1 ('MetaData "URI" "Miso.Types" "miso-1.12.0.0-3oTEkIY5ghsJIhsGmxcUXU" 'False) (C1 ('MetaCons "URI" 'PrefixI 'True) (S1 ('MetaSel ('Just "uriPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MisoString) :*: (S1 ('MetaSel ('Just "uriFragment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MisoString) :*: S1 ('MetaSel ('Just "uriQueryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map MisoString (Maybe MisoString))))))Defined in miso-1.12.0.0 · Miso.Types

Orphan instances

2 instances

FromJSON URI
FromMisoString URI