Safe Haskell	Safe-Inferred
Language	GHC2021

Web.Hyperbole.Route

Synopsis

type IsAbsolute = Bool
type Segment = Text
data Path = Path {
- isAbsolute :: Bool
- segments :: [Segment]
}
class Route a where
- matchRoute :: Path -> Maybe a
- routePath :: a -> Path
- defRoute :: a
findRoute :: Route a => [Text] -> Maybe a
pathUrl :: Path -> Url
cleanSegment :: Segment -> Segment
pathSegments :: Text -> [Segment]
class GenRoute f where
- genRoute :: [Text] -> Maybe (f p)
- genPaths :: f p -> [Text]
- genFirst :: f p
genRouteRead :: Read x => [Text] -> Maybe (K1 R x a)
matchRouteRead :: Read a => Path -> Maybe a
routePathShow :: Show a => a -> Path

Documentation

type IsAbsolute = Bool Source #

type Segment = Text Source #

data Path Source #

Constructors

Path
Fields isAbsolute :: Bool segments :: [Segment]

Instances

Instances details

IsString Path Source #
Instance details Defined in Web.Hyperbole.Route Methods fromString :: String -> Path #
Show Path Source #
Instance details Defined in Web.Hyperbole.Route Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #

class Route a where Source #

Minimal complete definition

Nothing

Methods

matchRoute :: Path -> Maybe a Source #

default matchRoute :: (Generic a, GenRoute (Rep a)) => Path -> Maybe a Source #

routePath :: a -> Path Source #

default routePath :: (Generic a, Eq a, GenRoute (Rep a)) => a -> Path Source #

defRoute :: a Source #

default defRoute :: (Generic a, GenRoute (Rep a)) => a Source #

Instances

Instances details

Route Text Source #
Instance details Defined in Web.Hyperbole.Route Methods matchRoute :: Path -> Maybe Text Source # routePath :: Text -> Path Source # defRoute :: Text Source #
Route String Source #
Instance details Defined in Web.Hyperbole.Route Methods matchRoute :: Path -> Maybe String Source # routePath :: String -> Path Source # defRoute :: String Source #
Route Integer Source #
Instance details Defined in Web.Hyperbole.Route Methods matchRoute :: Path -> Maybe Integer Source # routePath :: Integer -> Path Source # defRoute :: Integer Source #
Route Int Source #
Instance details Defined in Web.Hyperbole.Route Methods matchRoute :: Path -> Maybe Int Source # routePath :: Int -> Path Source # defRoute :: Int Source #
Route a => Route (Maybe a) Source #
Instance details Defined in Web.Hyperbole.Route Methods matchRoute :: Path -> Maybe (Maybe a) Source # routePath :: Maybe a -> Path Source # defRoute :: Maybe a Source #

findRoute :: Route a => [Text] -> Maybe a Source #

Use the default route if it's empty

pathUrl :: Path -> Url Source #

cleanSegment :: Segment -> Segment Source #

pathSegments :: Text -> [Segment] Source #

class GenRoute f where Source #

Methods

genRoute :: [Text] -> Maybe (f p) Source #

genPaths :: f p -> [Text] Source #

genFirst :: f p Source #

Instances

Instances details

GenRoute (U1 :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Route Methods genRoute :: forall (p :: k0). [Text] -> Maybe (U1 p) Source # genPaths :: forall (p :: k0). U1 p -> [Text] Source # genFirst :: forall (p :: k0). U1 p Source #
(GenRoute a, GenRoute b) => GenRoute (a :*: b :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Route Methods genRoute :: forall (p :: k0). [Text] -> Maybe ((a :: b) p) Source # genPaths :: forall (p :: k0). (a :: b) p -> [Text] Source # genFirst :: forall (p :: k0). (a :*: b) p Source #
(GenRoute a, GenRoute b) => GenRoute (a :+: b :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Route Methods genRoute :: forall (p :: k0). [Text] -> Maybe ((a :+: b) p) Source # genPaths :: forall (p :: k0). (a :+: b) p -> [Text] Source # genFirst :: forall (p :: k0). (a :+: b) p Source #
Route sub => GenRoute (K1 R sub :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Route Methods genRoute :: forall (p :: k0). [Text] -> Maybe (K1 R sub p) Source # genPaths :: forall (p :: k0). K1 R sub p -> [Text] Source # genFirst :: forall (p :: k0). K1 R sub p Source #
(Constructor c, GenRoute f) => GenRoute (M1 C c f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Route Methods genRoute :: forall (p :: k0). [Text] -> Maybe (M1 C c f p) Source # genPaths :: forall (p :: k0). M1 C c f p -> [Text] Source # genFirst :: forall (p :: k0). M1 C c f p Source #
GenRoute f => GenRoute (M1 D c f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Route Methods genRoute :: forall (p :: k0). [Text] -> Maybe (M1 D c f p) Source # genPaths :: forall (p :: k0). M1 D c f p -> [Text] Source # genFirst :: forall (p :: k0). M1 D c f p Source #
GenRoute f => GenRoute (M1 S c f :: k -> Type) Source #
Instance details Defined in Web.Hyperbole.Route Methods genRoute :: forall (p :: k0). [Text] -> Maybe (M1 S c f p) Source # genPaths :: forall (p :: k0). M1 S c f p -> [Text] Source # genFirst :: forall (p :: k0). M1 S c f p Source #

genRouteRead :: Read x => [Text] -> Maybe (K1 R x a) Source #

matchRouteRead :: Read a => Path -> Maybe a Source #

routePathShow :: Show a => a -> Path Source #