yesod-core
Safe HaskellNone
LanguageHaskell2010

Yesod.Routes.TH.Types

Description

Warning! This module is considered internal and may have breaking changes

Synopsis

Data types

data Resource typ Source #

Constructors

Resource 

Instances

Instances details
Functor Resource Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

Foldable Resource Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

fold :: Monoid m => Resource m -> m

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

foldMap' :: Monoid m => (a -> m) -> Resource a -> m

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

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

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

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

foldr1 :: (a -> a -> a) -> Resource a -> a

foldl1 :: (a -> a -> a) -> Resource a -> a

toList :: Resource a -> [a]

null :: Resource a -> Bool

length :: Resource a -> Int

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

maximum :: Ord a => Resource a -> a

minimum :: Ord a => Resource a -> a

sum :: Num a => Resource a -> a

product :: Num a => Resource a -> a

Traversable Resource Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

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

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

Lift typ => Lift (Resource typ :: Type) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

lift :: Quote m => Resource typ -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Resource typ -> Code m (Resource typ)

Show typ => Show (Resource typ) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

showsPrec :: Int -> Resource typ -> ShowS

show :: Resource typ -> String

showList :: [Resource typ] -> ShowS

data ResourceTree typ Source #

Constructors

ResourceLeaf (Resource typ) 
ResourceParent String CheckOverlap (Set String) [Piece typ] [ResourceTree typ] 

Instances

Instances details
Functor ResourceTree Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

Foldable ResourceTree Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

fold :: Monoid m => ResourceTree m -> m

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

foldMap' :: Monoid m => (a -> m) -> ResourceTree a -> m

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

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

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

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

foldr1 :: (a -> a -> a) -> ResourceTree a -> a

foldl1 :: (a -> a -> a) -> ResourceTree a -> a

toList :: ResourceTree a -> [a]

null :: ResourceTree a -> Bool

length :: ResourceTree a -> Int

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

maximum :: Ord a => ResourceTree a -> a

minimum :: Ord a => ResourceTree a -> a

sum :: Num a => ResourceTree a -> a

product :: Num a => ResourceTree a -> a

Traversable ResourceTree Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

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

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

Lift typ => Lift (ResourceTree typ :: Type) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

lift :: Quote m => ResourceTree typ -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => ResourceTree typ -> Code m (ResourceTree typ)

Show typ => Show (ResourceTree typ) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

showsPrec :: Int -> ResourceTree typ -> ShowS

show :: ResourceTree typ -> String

showList :: [ResourceTree typ] -> ShowS

data Piece typ Source #

Constructors

Static String 
Dynamic typ 

Instances

Instances details
Functor Piece Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

Foldable Piece Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

fold :: Monoid m => Piece m -> m

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

foldMap' :: Monoid m => (a -> m) -> Piece a -> m

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

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

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

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

foldr1 :: (a -> a -> a) -> Piece a -> a

foldl1 :: (a -> a -> a) -> Piece a -> a

toList :: Piece a -> [a]

null :: Piece a -> Bool

length :: Piece a -> Int

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

maximum :: Ord a => Piece a -> a

minimum :: Ord a => Piece a -> a

sum :: Num a => Piece a -> a

product :: Num a => Piece a -> a

Traversable Piece Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

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

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

Lift typ => Lift (Piece typ :: Type) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

lift :: Quote m => Piece typ -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Piece typ -> Code m (Piece typ)

Show typ => Show (Piece typ) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

showsPrec :: Int -> Piece typ -> ShowS

show :: Piece typ -> String

showList :: [Piece typ] -> ShowS

data Dispatch typ Source #

Constructors

Methods 

Fields

Subsite 

Fields

Instances

Instances details
Functor Dispatch Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

Foldable Dispatch Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

fold :: Monoid m => Dispatch m -> m

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

foldMap' :: Monoid m => (a -> m) -> Dispatch a -> m

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

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

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

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

foldr1 :: (a -> a -> a) -> Dispatch a -> a

foldl1 :: (a -> a -> a) -> Dispatch a -> a

toList :: Dispatch a -> [a]

null :: Dispatch a -> Bool

length :: Dispatch a -> Int

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

maximum :: Ord a => Dispatch a -> a

minimum :: Ord a => Dispatch a -> a

sum :: Num a => Dispatch a -> a

product :: Num a => Dispatch a -> a

Traversable Dispatch Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

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

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

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

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

Lift typ => Lift (Dispatch typ :: Type) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

lift :: Quote m => Dispatch typ -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Dispatch typ -> Code m (Dispatch typ)

Show typ => Show (Dispatch typ) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

showsPrec :: Int -> Dispatch typ -> ShowS

show :: Dispatch typ -> String

showList :: [Dispatch typ] -> ShowS

type CheckOverlap = Bool Source #

data FlatResource a Source #

Constructors

FlatResource 

Fields

Instances

Instances details
Show a => Show (FlatResource a) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

showsPrec :: Int -> FlatResource a -> ShowS

show :: FlatResource a -> String

showList :: [FlatResource a] -> ShowS

data ParentDetails a Source #

The details of a ResourceParent gathered for a flattened resource: the parent's name, its path pieces, and the route attributes it contributes to its descendants.

Since: 1.7.0.0

Constructors

ParentDetails 

Fields

Instances

Instances details
Show a => Show (ParentDetails a) Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

showsPrec :: Int -> ParentDetails a -> ShowS

show :: ParentDetails a -> String

showList :: [ParentDetails a] -> ShowS

Route datatype type arguments

data TyArgs Source #

The type arguments of a route datatype, paired with the source Name each was derived from. A monomorphic site like App has NoTyArgs; a parameterized one like MySub subsite has SomeTyArgs.

Carrying the (non-)emptiness in the type — rather than as a bare list with a separate null check — keeps "are there type args?" and "what are they?" a single fact, so the populated branch hands you the NonEmpty directly.

Since: 1.7.0.0

Constructors

NoTyArgs 
SomeTyArgs (NonEmpty (Type, Name)) 

Instances

Instances details
Eq TyArgs Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

(==) :: TyArgs -> TyArgs -> Bool

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

Show TyArgs Source # 
Instance details

Defined in Yesod.Routes.TH.Types

Methods

showsPrec :: Int -> TyArgs -> ShowS

show :: TyArgs -> String

showList :: [TyArgs] -> ShowS

toTyArgs :: [(Type, Name)] -> TyArgs Source #

Build TyArgs from a list of (type, source-name) pairs.

Since: 1.7.0.0

tyArgsList :: TyArgs -> [(Type, Name)] Source #

The type arguments as a plain list (empty for NoTyArgs).

Since: 1.7.0.0

tyArgsTypes :: TyArgs -> [Type] Source #

Just the Types of the arguments, in order.

Since: 1.7.0.0

tyArgsBinders :: TyArgs -> [Name] Source #

Just the source Names of the arguments, in order.

Since: 1.7.0.0

tyArgsArity :: TyArgs -> Int Source #

How many type arguments there are.

Since: 1.7.0.0

hasTyArgs :: TyArgs -> Bool Source #

Whether there are any type arguments (i.e. the site is parameterized).

Since: 1.7.0.0

applyTyArgs :: Type -> TyArgs -> Type Source #

Apply the type arguments to a head type (e.g. a route/subroute type constructor), left to right. This replaces the ad-hoc foldl' AppT con (fst <$> tyargs) that recurred across the generators.

Since: 1.7.0.0

Helper functions

resourceMulti :: Resource typ -> Maybe typ Source #