Safe Haskell	None
Language	Haskell98

Yesod.Core.Types

Synopsis

type SessionMap = Map Text ByteString
type SaveSession = SessionMap -> IO [Header]
newtype SessionBackend = SessionBackend {
- sbLoadSession :: Request -> IO (SessionMap, SaveSession)
}
data SessionCookie = SessionCookie !(Either UTCTime ByteString) !ByteString !SessionMap
data ClientSessionDateCache = ClientSessionDateCache {
- csdcNow :: !UTCTime
- csdcExpires :: !UTCTime
- csdcExpiresSerialized :: !ByteString
}
data YesodRequest = YesodRequest {
- reqGetParams :: ![(Text, Text)]
- reqCookies :: ![(Text, Text)]
- reqWaiRequest :: !Request
- reqLangs :: ![Text]
- reqToken :: !(Maybe Text)
- reqSession :: !SessionMap
- reqAccept :: ![ContentType]
}
data YesodResponse
- = YRWai !Response
- | YRWaiApp !Application
- | YRPlain !Status ![Header] !ContentType !Content !SessionMap
type RequestBodyContents = ([(Text, Text)], [(Text, FileInfo)])
data FileInfo = FileInfo {
- fileName :: !Text
- fileContentType :: !Text
- fileSourceRaw :: !(ConduitT () ByteString (ResourceT IO) ())
- fileMove :: !(FilePath -> IO ())
}
data FileUpload
- = FileUploadMemory !(BackEnd ByteString)
- | FileUploadDisk !(InternalState -> BackEnd FilePath)
- | FileUploadSource !(BackEnd (ConduitT () ByteString (ResourceT IO) ()))
data Approot master
- = ApprootRelative
- | ApprootStatic !Text
- | ApprootMaster !(master -> Text)
- | ApprootRequest !(master -> Request -> Text)
type ResolvedApproot = Text
data AuthResult
- = Authorized
- | AuthenticationRequired
- | Unauthorized !Text
data ScriptLoadPosition master
- = BottomOfBody
- | BottomOfHeadBlocking
- | BottomOfHeadAsync !(BottomOfHeadAsync master)
type BottomOfHeadAsync master = [Text] -> Maybe (HtmlUrl (Route master)) -> HtmlUrl (Route master)
type Texts = [Text]
newtype WaiSubsite = WaiSubsite {
- runWaiSubsite :: Application
}
newtype WaiSubsiteWithAuth = WaiSubsiteWithAuth {
- runWaiSubsiteWithAuth :: Application
}
data RunHandlerEnv child site = RunHandlerEnv {
- rheRender :: !(Route site -> [(Text, Text)] -> Text)
- rheRoute :: !(Maybe (Route child))
- rheRouteToMaster :: !(Route child -> Route site)
- rheSite :: !site
- rheChild :: !child
- rheUpload :: !(RequestBodyLength -> FileUpload)
- rheLog :: !(Loc -> LogSource -> LogLevel -> LogStr -> IO ())
- rheOnError :: !(ErrorResponse -> YesodApp)
- rheMaxExpires :: !Text
}
data HandlerData child site = HandlerData {
- handlerRequest :: !YesodRequest
- handlerEnv :: !(RunHandlerEnv child site)
- handlerState :: !(IORef GHState)
- handlerResource :: !InternalState
}
data YesodRunnerEnv site = YesodRunnerEnv {
- yreLogger :: !Logger
- yreSite :: !site
- yreSessionBackend :: !(Maybe SessionBackend)
- yreGen :: !(IO Int)
- yreGetMaxExpires :: !(IO Text)
}
data YesodSubRunnerEnv sub parent = YesodSubRunnerEnv {
- ysreParentRunner :: !(ParentRunner parent)
- ysreGetSub :: !(parent -> sub)
- ysreToParentRoute :: !(Route sub -> Route parent)
- ysreParentEnv :: !(YesodRunnerEnv parent)
}
type ParentRunner parent = HandlerFor parent TypedContent -> YesodRunnerEnv parent -> Maybe (Route parent) -> Application
newtype HandlerFor site a = HandlerFor {
- unHandlerFor :: HandlerData site site -> IO a
}
data GHState = GHState {
- ghsSession :: !SessionMap
- ghsRBC :: !(Maybe RequestBodyContents)
- ghsIdent :: !Int
- ghsCache :: !TypeMap
- ghsCacheBy :: !KeyedTypeMap
- ghsHeaders :: !(Endo [Header])
}
type YesodApp = YesodRequest -> ResourceT IO YesodResponse
newtype WidgetFor site a = WidgetFor {
- unWidgetFor :: WidgetData site -> IO a
}
data WidgetData site = WidgetData {
- wdRef :: !(IORef (GWData (Route site)))
- wdHandler :: !(HandlerData site site)
}
tellWidget :: GWData (Route site) -> WidgetFor site ()
type RY master = Route master -> [(Text, Text)] -> Text
newtype CssBuilder = CssBuilder {
- unCssBuilder :: Builder
}
data PageContent url = PageContent {
- pageTitle :: !Html
- pageHead :: !(HtmlUrl url)
- pageBody :: !(HtmlUrl url)
}
data Content
- = ContentBuilder !Builder !(Maybe Int)
- | ContentSource !(ConduitT () (Flush Builder) (ResourceT IO) ())
- | ContentFile !FilePath !(Maybe FilePart)
- | ContentDontEvaluate !Content
data TypedContent = TypedContent !ContentType !Content
type RepHtml = Html
newtype RepJson = RepJson Content
newtype RepPlain = RepPlain Content
newtype RepXml = RepXml Content
type ContentType = ByteString
newtype DontFullyEvaluate a = DontFullyEvaluate {
- unDontFullyEvaluate :: a
}
data ErrorResponse
- = NotFound
- | InternalError !Text
- | InvalidArgs ![Text]
- | NotAuthenticated
- | PermissionDenied !Text
- | BadMethod !Method
data Header
- = AddCookie !SetCookie
- | DeleteCookie !ByteString !ByteString
- | Header !(CI ByteString) !ByteString
data Location url
- = Local !url
- | Remote !Text
newtype UniqueList x = UniqueList ([x] -> [x])
data Script url = Script {
- scriptLocation :: !(Location url)
- scriptAttributes :: ![(Text, Text)]
}
data Stylesheet url = Stylesheet {
- styleLocation :: !(Location url)
- styleAttributes :: ![(Text, Text)]
}
newtype Title = Title {
- unTitle :: Html
}
newtype Head url = Head (HtmlUrl url)
newtype Body url = Body (HtmlUrl url)
type CssBuilderUrl a = (a -> [(Text, Text)] -> Text) -> Builder
data GWData a = GWData {
- gwdBody :: !(Body a)
- gwdTitle :: !(Last Title)
- gwdScripts :: !(UniqueList (Script a))
- gwdStylesheets :: !(UniqueList (Stylesheet a))
- gwdCss :: !(Map (Maybe Text) (CssBuilderUrl a))
- gwdJavascript :: !(Maybe (JavascriptUrl a))
- gwdHead :: !(Head a)
}
data HandlerContents
- = HCContent !Status !TypedContent
- | HCError !ErrorResponse
- | HCSendFile !ContentType !FilePath !(Maybe FilePart)
- | HCRedirect !Status !Text
- | HCCreated !Text
- | HCWai !Response
- | HCWaiApp !Application
data Logger = Logger {
- loggerSet :: !LoggerSet
- loggerDate :: !DateCacheGetter
}
loggerPutStr :: Logger -> LogStr -> IO ()
newtype SubHandlerFor sub master a = SubHandlerFor {
- unSubHandlerFor :: HandlerData sub master -> IO a
}

Documentation

type SessionMap = Map Text ByteString Source #

type SaveSession Source #

Arguments

= SessionMap	The session contents after running the handler
-> IO [Header]

newtype SessionBackend Source #

Constructors

SessionBackend
Fields sbLoadSession :: Request -> IO (SessionMap, SaveSession) Return the session data and a function to save the session

data SessionCookie Source #

Constructors

SessionCookie !(Either UTCTime ByteString) !ByteString !SessionMap

Instances

Read SessionCookie Source #
Instance details Defined in Yesod.Core.Types Methods readsPrec :: Int -> ReadS SessionCookie # readList :: ReadS [SessionCookie] # readPrec :: ReadPrec SessionCookie # readListPrec :: ReadPrec [SessionCookie] #
Show SessionCookie Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> SessionCookie -> ShowS # show :: SessionCookie -> String # showList :: [SessionCookie] -> ShowS #
Serialize SessionCookie Source #
Instance details Defined in Yesod.Core.Types Methods put :: Putter SessionCookie # get :: Get SessionCookie #

data ClientSessionDateCache Source #

Constructors

ClientSessionDateCache
Fields csdcNow :: !UTCTime csdcExpires :: !UTCTime csdcExpiresSerialized :: !ByteString

Instances

Eq ClientSessionDateCache Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: ClientSessionDateCache -> ClientSessionDateCache -> Bool # (/=) :: ClientSessionDateCache -> ClientSessionDateCache -> Bool #
Show ClientSessionDateCache Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> ClientSessionDateCache -> ShowS # show :: ClientSessionDateCache -> String # showList :: [ClientSessionDateCache] -> ShowS #

data YesodRequest Source #

The parsed request information. This type augments the standard WAI Request with additional information.

Constructors

YesodRequest

Fields

reqGetParams :: ![(Text, Text)]
Same as queryString, but decoded to Text.
reqCookies :: ![(Text, Text)]
reqWaiRequest :: !Request
reqLangs :: ![Text]
Languages which the client supports. This is an ordered list by preference.
reqToken :: !(Maybe Text)
A random, session-specific token used to prevent CSRF attacks.
reqSession :: !SessionMap
Initial session sent from the client.
Since 1.2.0
reqAccept :: ![ContentType]
An ordered list of the accepted content types.
Since 1.2.0

data YesodResponse Source #

An augmented WAI Response. This can either be a standard Response, or a higher-level data structure which Yesod will turn into a Response.

Constructors

YRWai !Response
YRWaiApp !Application
YRPlain !Status ![Header] !ContentType !Content !SessionMap

type RequestBodyContents = ([(Text, Text)], [(Text, FileInfo)]) Source #

A tuple containing both the POST parameters and submitted files.

data FileInfo Source #

Constructors

FileInfo
Fields fileName :: !Text fileContentType :: !Text fileSourceRaw :: !(ConduitT () ByteString (ResourceT IO) ()) fileMove :: !(FilePath -> IO ())

data FileUpload Source #

Constructors

FileUploadMemory !(BackEnd ByteString)
FileUploadDisk !(InternalState -> BackEnd FilePath)
FileUploadSource !(BackEnd (ConduitT () ByteString (ResourceT IO) ()))

data Approot master Source #

How to determine the root of the application for constructing URLs.

Note that future versions of Yesod may add new constructors without bumping the major version number. As a result, you should not pattern match on Approot values.

Constructors

ApprootRelative	No application root.
ApprootStatic !Text
ApprootMaster !(master -> Text)
ApprootRequest !(master -> Request -> Text)

type ResolvedApproot = Text Source #

data AuthResult Source #

Constructors

Authorized
AuthenticationRequired
Unauthorized !Text

Instances

Eq AuthResult Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: AuthResult -> AuthResult -> Bool # (/=) :: AuthResult -> AuthResult -> Bool #
Read AuthResult Source #
Instance details Defined in Yesod.Core.Types Methods readsPrec :: Int -> ReadS AuthResult # readList :: ReadS [AuthResult] # readPrec :: ReadPrec AuthResult # readListPrec :: ReadPrec [AuthResult] #
Show AuthResult Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> AuthResult -> ShowS # show :: AuthResult -> String # showList :: [AuthResult] -> ShowS #

data ScriptLoadPosition master Source #

Constructors

BottomOfBody
BottomOfHeadBlocking
BottomOfHeadAsync !(BottomOfHeadAsync master)

type BottomOfHeadAsync master Source #

Arguments

= [Text]	urls to load asynchronously
-> Maybe (HtmlUrl (Route master))	widget of js to run on async completion
-> HtmlUrl (Route master)	widget to insert at the bottom of head

type Texts = [Text] Source #

newtype WaiSubsite Source #

Wrap up a normal WAI application as a Yesod subsite. Ignore parent site's middleware and isAuthorized.

Constructors

WaiSubsite
Fields runWaiSubsite :: Application

Instances

ParseRoute WaiSubsite Source #
Instance details Defined in Yesod.Core.Types Methods parseRoute :: ([Text], [(Text, Text)]) -> Maybe (Route WaiSubsite) Source #
RenderRoute WaiSubsite Source #
Instance details Defined in Yesod.Core.Types Associated Types data Route WaiSubsite :: * Source # Methods renderRoute :: Route WaiSubsite -> ([Text], [(Text, Text)]) Source #
YesodSubDispatch WaiSubsite master Source #
Instance details Defined in Yesod.Core.Class.Dispatch Methods yesodSubDispatch :: YesodSubRunnerEnv WaiSubsite master -> Application Source #
Eq (Route WaiSubsite) Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: Route WaiSubsite -> Route WaiSubsite -> Bool # (/=) :: Route WaiSubsite -> Route WaiSubsite -> Bool #
Ord (Route WaiSubsite) Source #
Instance details Defined in Yesod.Core.Types Methods compare :: Route WaiSubsite -> Route WaiSubsite -> Ordering # (<) :: Route WaiSubsite -> Route WaiSubsite -> Bool # (<=) :: Route WaiSubsite -> Route WaiSubsite -> Bool # (>) :: Route WaiSubsite -> Route WaiSubsite -> Bool # (>=) :: Route WaiSubsite -> Route WaiSubsite -> Bool # max :: Route WaiSubsite -> Route WaiSubsite -> Route WaiSubsite # min :: Route WaiSubsite -> Route WaiSubsite -> Route WaiSubsite #
Read (Route WaiSubsite) Source #
Instance details Defined in Yesod.Core.Types Methods readsPrec :: Int -> ReadS (Route WaiSubsite) # readList :: ReadS [Route WaiSubsite] # readPrec :: ReadPrec (Route WaiSubsite) # readListPrec :: ReadPrec [Route WaiSubsite] #
Show (Route WaiSubsite) Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> Route WaiSubsite -> ShowS # show :: Route WaiSubsite -> String # showList :: [Route WaiSubsite] -> ShowS #
data Route WaiSubsite Source #
Instance details Defined in Yesod.Core.Types data Route WaiSubsite = WaiSubsiteRoute [Text] [(Text, Text)]

newtype WaiSubsiteWithAuth Source #

Like WaiSubsite, but applies parent site's middleware and isAuthorized.

Since: yesod-core-1.4.34

Constructors

WaiSubsiteWithAuth
Fields runWaiSubsiteWithAuth :: Application

Instances

ParseRoute WaiSubsiteWithAuth Source #
Instance details Defined in Yesod.Core.Types Methods parseRoute :: ([Text], [(Text, Text)]) -> Maybe (Route WaiSubsiteWithAuth) Source #
RenderRoute WaiSubsiteWithAuth Source #
Instance details Defined in Yesod.Core.Types Associated Types data Route WaiSubsiteWithAuth :: * Source # Methods renderRoute :: Route WaiSubsiteWithAuth -> ([Text], [(Text, Text)]) Source #
YesodSubDispatch WaiSubsiteWithAuth master Source #
Instance details Defined in Yesod.Core.Class.Dispatch Methods yesodSubDispatch :: YesodSubRunnerEnv WaiSubsiteWithAuth master -> Application Source #
Eq (Route WaiSubsiteWithAuth) Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Bool # (/=) :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Bool #
Ord (Route WaiSubsiteWithAuth) Source #
Instance details Defined in Yesod.Core.Types Methods compare :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Ordering # (<) :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Bool # (<=) :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Bool # (>) :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Bool # (>=) :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Bool # max :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth # min :: Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth -> Route WaiSubsiteWithAuth #
Read (Route WaiSubsiteWithAuth) Source #
Instance details Defined in Yesod.Core.Types Methods readsPrec :: Int -> ReadS (Route WaiSubsiteWithAuth) # readList :: ReadS [Route WaiSubsiteWithAuth] # readPrec :: ReadPrec (Route WaiSubsiteWithAuth) # readListPrec :: ReadPrec [Route WaiSubsiteWithAuth] #
Show (Route WaiSubsiteWithAuth) Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> Route WaiSubsiteWithAuth -> ShowS # show :: Route WaiSubsiteWithAuth -> String # showList :: [Route WaiSubsiteWithAuth] -> ShowS #
data Route WaiSubsiteWithAuth Source #
Instance details Defined in Yesod.Core.Types data Route WaiSubsiteWithAuth = WaiSubsiteWithAuthRoute [Text] [(Text, Text)]

data RunHandlerEnv child site Source #

Constructors

RunHandlerEnv

Fields

rheRender :: !(Route site -> [(Text, Text)] -> Text)
rheRoute :: !(Maybe (Route child))
rheRouteToMaster :: !(Route child -> Route site)
rheSite :: !site
rheChild :: !child
rheUpload :: !(RequestBodyLength -> FileUpload)
rheLog :: !(Loc -> LogSource -> LogLevel -> LogStr -> IO ())
rheOnError :: !(ErrorResponse -> YesodApp)
How to respond when an error is thrown internally.
Since 1.2.0
rheMaxExpires :: !Text

data HandlerData child site Source #

Constructors

HandlerData
Fields handlerRequest :: !YesodRequest handlerEnv :: !(RunHandlerEnv child site) handlerState :: !(IORef GHState) handlerResource :: !InternalState

Instances

MonadReader (HandlerData site site) (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods ask :: HandlerFor site (HandlerData site site) # local :: (HandlerData site site -> HandlerData site site) -> HandlerFor site a -> HandlerFor site a # reader :: (HandlerData site site -> a) -> HandlerFor site a #
MonadReader (HandlerData child master) (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods ask :: SubHandlerFor child master (HandlerData child master) # local :: (HandlerData child master -> HandlerData child master) -> SubHandlerFor child master a -> SubHandlerFor child master a # reader :: (HandlerData child master -> a) -> SubHandlerFor child master a #

data YesodRunnerEnv site Source #

Constructors

YesodRunnerEnv
Fields yreLogger :: !Logger yreSite :: !site yreSessionBackend :: !(Maybe SessionBackend) yreGen :: !(IO Int) Generate a random number yreGetMaxExpires :: !(IO Text)

data YesodSubRunnerEnv sub parent Source #

Constructors

YesodSubRunnerEnv
Fields ysreParentRunner :: !(ParentRunner parent) ysreGetSub :: !(parent -> sub) ysreToParentRoute :: !(Route sub -> Route parent) ysreParentEnv :: !(YesodRunnerEnv parent)

type ParentRunner parent = HandlerFor parent TypedContent -> YesodRunnerEnv parent -> Maybe (Route parent) -> Application Source #

newtype HandlerFor site a Source #

A generic handler monad, which can have a different subsite and master site. We define a newtype for better error message.

Constructors

HandlerFor
Fields unHandlerFor :: HandlerData site site -> IO a

Instances

Monad (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods (>>=) :: HandlerFor site a -> (a -> HandlerFor site b) -> HandlerFor site b # (>>) :: HandlerFor site a -> HandlerFor site b -> HandlerFor site b # return :: a -> HandlerFor site a # fail :: String -> HandlerFor site a #
Functor (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods fmap :: (a -> b) -> HandlerFor site a -> HandlerFor site b # (<$) :: a -> HandlerFor site b -> HandlerFor site a #
Applicative (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods pure :: a -> HandlerFor site a # (<>) :: HandlerFor site (a -> b) -> HandlerFor site a -> HandlerFor site b # liftA2 :: (a -> b -> c) -> HandlerFor site a -> HandlerFor site b -> HandlerFor site c # (>) :: HandlerFor site a -> HandlerFor site b -> HandlerFor site b # (<*) :: HandlerFor site a -> HandlerFor site b -> HandlerFor site a #
MonadIO (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods liftIO :: IO a -> HandlerFor site a #
MonadUnliftIO (HandlerFor site) Source #	Since: yesod-core-1.4.38
Instance details Defined in Yesod.Core.Types Methods askUnliftIO :: HandlerFor site (UnliftIO (HandlerFor site)) # withRunInIO :: ((forall a. HandlerFor site a -> IO a) -> IO b) -> HandlerFor site b #
MonadResource (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods liftResourceT :: ResourceT IO a -> HandlerFor site a #
PrimMonad (HandlerFor site) Source #	Since: yesod-core-1.6.7
Instance details Defined in Yesod.Core.Types Associated Types type PrimState (HandlerFor site) :: * # Methods primitive :: (State# (PrimState (HandlerFor site)) -> (#State# (PrimState (HandlerFor site)), a#)) -> HandlerFor site a #
MonadThrow (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods throwM :: Exception e => e -> HandlerFor site a #
MonadLogger (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> HandlerFor site () #
MonadLoggerIO (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods askLoggerIO :: HandlerFor site (Loc -> LogSource -> LogLevel -> LogStr -> IO ()) #
MonadHandler (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Class.Handler Associated Types type HandlerSite (HandlerFor site) :: * Source # type SubHandlerSite (HandlerFor site) :: * Source # Methods liftHandler :: HandlerFor (HandlerSite (HandlerFor site)) a -> HandlerFor site a Source # liftSubHandler :: SubHandlerFor (SubHandlerSite (HandlerFor site)) (HandlerSite (HandlerFor site)) a -> HandlerFor site a Source #
MonadReader (HandlerData site site) (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types Methods ask :: HandlerFor site (HandlerData site site) # local :: (HandlerData site site -> HandlerData site site) -> HandlerFor site a -> HandlerFor site a # reader :: (HandlerData site site -> a) -> HandlerFor site a #
type PrimState (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Types type PrimState (HandlerFor site) = PrimState IO
type HandlerSite (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Class.Handler type HandlerSite (HandlerFor site) = site
type SubHandlerSite (HandlerFor site) Source #
Instance details Defined in Yesod.Core.Class.Handler type SubHandlerSite (HandlerFor site) = site

data GHState Source #

Constructors

GHState
Fields ghsSession :: !SessionMap ghsRBC :: !(Maybe RequestBodyContents) ghsIdent :: !Int ghsCache :: !TypeMap ghsCacheBy :: !KeyedTypeMap ghsHeaders :: !(Endo [Header])

type YesodApp = YesodRequest -> ResourceT IO YesodResponse Source #

An extension of the basic WAI Application datatype to provide extra features needed by Yesod. Users should never need to use this directly, as the HandlerT monad and template haskell code should hide it away.

newtype WidgetFor site a Source #

A generic widget, allowing specification of both the subsite and master site datatypes. While this is simply a WriterT, we define a newtype for better error messages.

Constructors

WidgetFor
Fields unWidgetFor :: WidgetData site -> IO a

Instances

(site' ~ site, a ~ ()) => ToWidget site' (WidgetFor site a) Source #
Instance details Defined in Yesod.Core.Widget Methods toWidget :: (MonadWidget m, HandlerSite m ~ site') => WidgetFor site a -> m () Source #
Monad (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods (>>=) :: WidgetFor site a -> (a -> WidgetFor site b) -> WidgetFor site b # (>>) :: WidgetFor site a -> WidgetFor site b -> WidgetFor site b # return :: a -> WidgetFor site a # fail :: String -> WidgetFor site a #
Functor (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods fmap :: (a -> b) -> WidgetFor site a -> WidgetFor site b # (<$) :: a -> WidgetFor site b -> WidgetFor site a #
Applicative (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods pure :: a -> WidgetFor site a # (<>) :: WidgetFor site (a -> b) -> WidgetFor site a -> WidgetFor site b # liftA2 :: (a -> b -> c) -> WidgetFor site a -> WidgetFor site b -> WidgetFor site c # (>) :: WidgetFor site a -> WidgetFor site b -> WidgetFor site b # (<*) :: WidgetFor site a -> WidgetFor site b -> WidgetFor site a #
MonadIO (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods liftIO :: IO a -> WidgetFor site a #
MonadUnliftIO (WidgetFor site) Source #	Since: yesod-core-1.4.38
Instance details Defined in Yesod.Core.Types Methods askUnliftIO :: WidgetFor site (UnliftIO (WidgetFor site)) # withRunInIO :: ((forall a. WidgetFor site a -> IO a) -> IO b) -> WidgetFor site b #
MonadResource (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods liftResourceT :: ResourceT IO a -> WidgetFor site a #
PrimMonad (WidgetFor site) Source #	Since: yesod-core-1.6.7
Instance details Defined in Yesod.Core.Types Associated Types type PrimState (WidgetFor site) :: * # Methods primitive :: (State# (PrimState (WidgetFor site)) -> (#State# (PrimState (WidgetFor site)), a#)) -> WidgetFor site a #
MonadThrow (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods throwM :: Exception e => e -> WidgetFor site a #
MonadLogger (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> WidgetFor site () #
MonadLoggerIO (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods askLoggerIO :: WidgetFor site (Loc -> LogSource -> LogLevel -> LogStr -> IO ()) #
MonadWidget (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Class.Handler Methods liftWidget :: WidgetFor (HandlerSite (WidgetFor site)) a -> WidgetFor site a Source #
MonadHandler (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Class.Handler Associated Types type HandlerSite (WidgetFor site) :: * Source # type SubHandlerSite (WidgetFor site) :: * Source # Methods liftHandler :: HandlerFor (HandlerSite (WidgetFor site)) a -> WidgetFor site a Source # liftSubHandler :: SubHandlerFor (SubHandlerSite (WidgetFor site)) (HandlerSite (WidgetFor site)) a -> WidgetFor site a Source #
MonadReader (WidgetData site) (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods ask :: WidgetFor site (WidgetData site) # local :: (WidgetData site -> WidgetData site) -> WidgetFor site a -> WidgetFor site a # reader :: (WidgetData site -> a) -> WidgetFor site a #
a ~ () => IsString (WidgetFor site a) Source #	A `String` can be trivially promoted to a widget. For example, in a yesod-scaffold site you could use: getHomeR = do defaultLayout "Widget text"
Instance details Defined in Yesod.Core.Types Methods fromString :: String -> WidgetFor site a #
a ~ () => Semigroup (WidgetFor site a) Source #
Instance details Defined in Yesod.Core.Types Methods (<>) :: WidgetFor site a -> WidgetFor site a -> WidgetFor site a # sconcat :: NonEmpty (WidgetFor site a) -> WidgetFor site a # stimes :: Integral b => b -> WidgetFor site a -> WidgetFor site a #
a ~ () => Monoid (WidgetFor site a) Source #
Instance details Defined in Yesod.Core.Types Methods mempty :: WidgetFor site a # mappend :: WidgetFor site a -> WidgetFor site a -> WidgetFor site a # mconcat :: [WidgetFor site a] -> WidgetFor site a #
type PrimState (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types type PrimState (WidgetFor site) = PrimState IO
type HandlerSite (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Class.Handler type HandlerSite (WidgetFor site) = site
type SubHandlerSite (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Class.Handler type SubHandlerSite (WidgetFor site) = site

data WidgetData site Source #

Constructors

WidgetData
Fields wdRef :: !(IORef (GWData (Route site))) wdHandler :: !(HandlerData site site)

Instances

MonadReader (WidgetData site) (WidgetFor site) Source #
Instance details Defined in Yesod.Core.Types Methods ask :: WidgetFor site (WidgetData site) # local :: (WidgetData site -> WidgetData site) -> WidgetFor site a -> WidgetFor site a # reader :: (WidgetData site -> a) -> WidgetFor site a #

tellWidget :: GWData (Route site) -> WidgetFor site () Source #

type RY master = Route master -> [(Text, Text)] -> Text Source #

newtype CssBuilder Source #

Newtype wrapper allowing injection of arbitrary content into CSS.

Usage:

toWidget $ CssBuilder "p { color: red }"

Since: 1.1.3

Constructors

CssBuilder
Fields unCssBuilder :: Builder

Instances

ToWidgetHead site CssBuilder Source #
Instance details Defined in Yesod.Core.Widget Methods toWidgetHead :: (MonadWidget m, HandlerSite m ~ site) => CssBuilder -> m () Source #
ToWidgetMedia site CssBuilder Source #
Instance details Defined in Yesod.Core.Widget Methods toWidgetMedia :: (MonadWidget m, HandlerSite m ~ site) => Text -> CssBuilder -> m () Source #
ToWidget site CssBuilder Source #
Instance details Defined in Yesod.Core.Widget Methods toWidget :: (MonadWidget m, HandlerSite m ~ site) => CssBuilder -> m () Source #
render ~ RY site => ToWidgetHead site (render -> CssBuilder) Source #
Instance details Defined in Yesod.Core.Widget Methods toWidgetHead :: (MonadWidget m, HandlerSite m ~ site) => (render -> CssBuilder) -> m () Source #
render ~ RY site => ToWidgetMedia site (render -> CssBuilder) Source #
Instance details Defined in Yesod.Core.Widget Methods toWidgetMedia :: (MonadWidget m, HandlerSite m ~ site) => Text -> (render -> CssBuilder) -> m () Source #
render ~ RY site => ToWidget site (render -> CssBuilder) Source #
Instance details Defined in Yesod.Core.Widget Methods toWidget :: (MonadWidget m, HandlerSite m ~ site) => (render -> CssBuilder) -> m () Source #

data PageContent url Source #

Content for a web page. By providing this datatype, we can easily create generic site templates, which would have the type signature:

PageContent url -> HtmlUrl url

Constructors

PageContent
Fields pageTitle :: !Html pageHead :: !(HtmlUrl url) pageBody :: !(HtmlUrl url)

data Content Source #

Constructors

ContentBuilder !Builder !(Maybe Int)	The content and optional content length.
ContentSource !(ConduitT () (Flush Builder) (ResourceT IO) ())
ContentFile !FilePath !(Maybe FilePart)
ContentDontEvaluate !Content

Instances

IsString Content Source #
Instance details Defined in Yesod.Core.Types Methods fromString :: String -> Content #
ToContent Content Source #
Instance details Defined in Yesod.Core.Content Methods toContent :: Content -> Content Source #
ToTypedContent (ContentType, Content) Source #
Instance details Defined in Yesod.Core.Content Methods toTypedContent :: (ContentType, Content) -> TypedContent Source #
ToContent (ContentType, Content) Source #
Instance details Defined in Yesod.Core.Content Methods toContent :: (ContentType, Content) -> Content Source #

data TypedContent Source #

Constructors

TypedContent !ContentType !Content

Instances

ToTypedContent TypedContent Source #
Instance details Defined in Yesod.Core.Content Methods toTypedContent :: TypedContent -> TypedContent Source #
ToContent TypedContent Source #
Instance details Defined in Yesod.Core.Content Methods toContent :: TypedContent -> Content Source #

type RepHtml = Html Source #

Deprecated: Please use Html instead

newtype RepJson Source #

Constructors

RepJson Content

Instances

ToTypedContent RepJson Source #
Instance details Defined in Yesod.Core.Content Methods toTypedContent :: RepJson -> TypedContent Source #
HasContentType RepJson Source #
Instance details Defined in Yesod.Core.Content Methods getContentType :: Monad m => m RepJson -> ContentType Source #
ToContent RepJson Source #
Instance details Defined in Yesod.Core.Content Methods toContent :: RepJson -> Content Source #

newtype RepPlain Source #

Constructors

RepPlain Content

Instances

ToTypedContent RepPlain Source #
Instance details Defined in Yesod.Core.Content Methods toTypedContent :: RepPlain -> TypedContent Source #
HasContentType RepPlain Source #
Instance details Defined in Yesod.Core.Content Methods getContentType :: Monad m => m RepPlain -> ContentType Source #
ToContent RepPlain Source #
Instance details Defined in Yesod.Core.Content Methods toContent :: RepPlain -> Content Source #

newtype RepXml Source #

Constructors

RepXml Content

Instances

ToTypedContent RepXml Source #
Instance details Defined in Yesod.Core.Content Methods toTypedContent :: RepXml -> TypedContent Source #
HasContentType RepXml Source #
Instance details Defined in Yesod.Core.Content Methods getContentType :: Monad m => m RepXml -> ContentType Source #
ToContent RepXml Source #
Instance details Defined in Yesod.Core.Content Methods toContent :: RepXml -> Content Source #

type ContentType = ByteString Source #

newtype DontFullyEvaluate a Source #

Prevents a response body from being fully evaluated before sending the request.

Since 1.1.0

Constructors

DontFullyEvaluate
Fields unDontFullyEvaluate :: a

Instances

ToTypedContent a => ToTypedContent (DontFullyEvaluate a) Source #
Instance details Defined in Yesod.Core.Content Methods toTypedContent :: DontFullyEvaluate a -> TypedContent Source #
HasContentType a => HasContentType (DontFullyEvaluate a) Source #
Instance details Defined in Yesod.Core.Content Methods getContentType :: Monad m => m (DontFullyEvaluate a) -> ContentType Source #
ToContent a => ToContent (DontFullyEvaluate a) Source #
Instance details Defined in Yesod.Core.Content Methods toContent :: DontFullyEvaluate a -> Content Source #

data ErrorResponse Source #

Responses to indicate some form of an error occurred.

Constructors

NotFound
InternalError !Text
InvalidArgs ![Text]
NotAuthenticated
PermissionDenied !Text
BadMethod !Method

Instances

Eq ErrorResponse Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: ErrorResponse -> ErrorResponse -> Bool # (/=) :: ErrorResponse -> ErrorResponse -> Bool #
Show ErrorResponse Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> ErrorResponse -> ShowS # show :: ErrorResponse -> String # showList :: [ErrorResponse] -> ShowS #
Generic ErrorResponse Source #
Instance details Defined in Yesod.Core.Types Associated Types type Rep ErrorResponse :: * -> * # Methods from :: ErrorResponse -> Rep ErrorResponse x # to :: Rep ErrorResponse x -> ErrorResponse #
NFData ErrorResponse Source #
Instance details Defined in Yesod.Core.Types Methods rnf :: ErrorResponse -> () #
type Rep ErrorResponse Source #
Instance details Defined in Yesod.Core.Types type Rep ErrorResponse = D1 (MetaData "ErrorResponse" "Yesod.Core.Types" "yesod-core-1.6.8-IPwTsaHeN399XyW6sEFPEC" False) ((C1 (MetaCons "NotFound" PrefixI False) (U1 :: * -> ) :+: (C1 (MetaCons "InternalError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: C1 (MetaCons "InvalidArgs" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])))) :+: (C1 (MetaCons "NotAuthenticated" PrefixI False) (U1 :: -> *) :+: (C1 (MetaCons "PermissionDenied" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: C1 (MetaCons "BadMethod" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Method)))))

data Header Source #

Headers to be added to a Result.

Constructors

AddCookie !SetCookie
DeleteCookie !ByteString !ByteString	name and path
Header !(CI ByteString) !ByteString	key and value

data Location url Source #

Constructors

Local !url
Remote !Text

Instances

Eq url => Eq (Location url) Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: Location url -> Location url -> Bool # (/=) :: Location url -> Location url -> Bool #
Show url => Show (Location url) Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> Location url -> ShowS # show :: Location url -> String # showList :: [Location url] -> ShowS #

newtype UniqueList x Source #

A diff list that does not directly enforce uniqueness. When creating a widget Yesod will use nub to make it unique.

Constructors

UniqueList ([x] -> [x])

Instances

Semigroup (UniqueList x) Source #
Instance details Defined in Yesod.Core.Types Methods (<>) :: UniqueList x -> UniqueList x -> UniqueList x # sconcat :: NonEmpty (UniqueList x) -> UniqueList x # stimes :: Integral b => b -> UniqueList x -> UniqueList x #
Monoid (UniqueList x) Source #
Instance details Defined in Yesod.Core.Types Methods mempty :: UniqueList x # mappend :: UniqueList x -> UniqueList x -> UniqueList x # mconcat :: [UniqueList x] -> UniqueList x #

data Script url Source #

Constructors

Script
Fields scriptLocation :: !(Location url) scriptAttributes :: ![(Text, Text)]

Instances

Eq url => Eq (Script url) Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: Script url -> Script url -> Bool # (/=) :: Script url -> Script url -> Bool #
Show url => Show (Script url) Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> Script url -> ShowS # show :: Script url -> String # showList :: [Script url] -> ShowS #

data Stylesheet url Source #

Constructors

Stylesheet
Fields styleLocation :: !(Location url) styleAttributes :: ![(Text, Text)]

Instances

Eq url => Eq (Stylesheet url) Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: Stylesheet url -> Stylesheet url -> Bool # (/=) :: Stylesheet url -> Stylesheet url -> Bool #
Show url => Show (Stylesheet url) Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> Stylesheet url -> ShowS # show :: Stylesheet url -> String # showList :: [Stylesheet url] -> ShowS #

newtype Title Source #

Constructors

Title
Fields unTitle :: Html

newtype Head url Source #

Constructors

Head (HtmlUrl url)

Instances

Semigroup (Head url) Source #
Instance details Defined in Yesod.Core.Types Methods (<>) :: Head url -> Head url -> Head url # sconcat :: NonEmpty (Head url) -> Head url # stimes :: Integral b => b -> Head url -> Head url #
Monoid (Head url) Source #
Instance details Defined in Yesod.Core.Types Methods mempty :: Head url # mappend :: Head url -> Head url -> Head url # mconcat :: [Head url] -> Head url #

newtype Body url Source #

Constructors

Body (HtmlUrl url)

Instances

Semigroup (Body url) Source #
Instance details Defined in Yesod.Core.Types Methods (<>) :: Body url -> Body url -> Body url # sconcat :: NonEmpty (Body url) -> Body url # stimes :: Integral b => b -> Body url -> Body url #
Monoid (Body url) Source #
Instance details Defined in Yesod.Core.Types Methods mempty :: Body url # mappend :: Body url -> Body url -> Body url # mconcat :: [Body url] -> Body url #

type CssBuilderUrl a = (a -> [(Text, Text)] -> Text) -> Builder Source #

data GWData a Source #

Constructors

GWData
Fields gwdBody :: !(Body a) gwdTitle :: !(Last Title) gwdScripts :: !(UniqueList (Script a)) gwdStylesheets :: !(UniqueList (Stylesheet a)) gwdCss :: !(Map (Maybe Text) (CssBuilderUrl a)) gwdJavascript :: !(Maybe (JavascriptUrl a)) gwdHead :: !(Head a)

Instances

Semigroup (GWData a) Source #
Instance details Defined in Yesod.Core.Types Methods (<>) :: GWData a -> GWData a -> GWData a # sconcat :: NonEmpty (GWData a) -> GWData a # stimes :: Integral b => b -> GWData a -> GWData a #
Monoid (GWData a) Source #
Instance details Defined in Yesod.Core.Types Methods mempty :: GWData a # mappend :: GWData a -> GWData a -> GWData a # mconcat :: [GWData a] -> GWData a #

data HandlerContents Source #

Constructors

HCContent !Status !TypedContent
HCError !ErrorResponse
HCSendFile !ContentType !FilePath !(Maybe FilePart)
HCRedirect !Status !Text
HCCreated !Text
HCWai !Response
HCWaiApp !Application

Instances

Show HandlerContents Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> HandlerContents -> ShowS # show :: HandlerContents -> String # showList :: [HandlerContents] -> ShowS #
Exception HandlerContents Source #
Instance details Defined in Yesod.Core.Types Methods toException :: HandlerContents -> SomeException # fromException :: SomeException -> Maybe HandlerContents # displayException :: HandlerContents -> String #

data Logger Source #

Constructors

Logger
Fields loggerSet :: !LoggerSet loggerDate :: !DateCacheGetter

loggerPutStr :: Logger -> LogStr -> IO () Source #

newtype SubHandlerFor sub master a Source #

A handler monad for subsite

Since: yesod-core-1.6.0

Constructors

SubHandlerFor
Fields unSubHandlerFor :: HandlerData sub master -> IO a

Instances

Monad (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods (>>=) :: SubHandlerFor child master a -> (a -> SubHandlerFor child master b) -> SubHandlerFor child master b # (>>) :: SubHandlerFor child master a -> SubHandlerFor child master b -> SubHandlerFor child master b # return :: a -> SubHandlerFor child master a # fail :: String -> SubHandlerFor child master a #
Functor (SubHandlerFor sub master) Source #
Instance details Defined in Yesod.Core.Types Methods fmap :: (a -> b) -> SubHandlerFor sub master a -> SubHandlerFor sub master b # (<$) :: a -> SubHandlerFor sub master b -> SubHandlerFor sub master a #
Applicative (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods pure :: a -> SubHandlerFor child master a # (<>) :: SubHandlerFor child master (a -> b) -> SubHandlerFor child master a -> SubHandlerFor child master b # liftA2 :: (a -> b -> c) -> SubHandlerFor child master a -> SubHandlerFor child master b -> SubHandlerFor child master c # (>) :: SubHandlerFor child master a -> SubHandlerFor child master b -> SubHandlerFor child master b # (<*) :: SubHandlerFor child master a -> SubHandlerFor child master b -> SubHandlerFor child master a #
MonadIO (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods liftIO :: IO a -> SubHandlerFor child master a #
MonadUnliftIO (SubHandlerFor child master) Source #	Since: yesod-core-1.4.38
Instance details Defined in Yesod.Core.Types Methods askUnliftIO :: SubHandlerFor child master (UnliftIO (SubHandlerFor child master)) # withRunInIO :: ((forall a. SubHandlerFor child master a -> IO a) -> IO b) -> SubHandlerFor child master b #
MonadResource (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods liftResourceT :: ResourceT IO a -> SubHandlerFor child master a #
MonadThrow (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods throwM :: Exception e => e -> SubHandlerFor child master a #
MonadLogger (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> SubHandlerFor child master () #
MonadLoggerIO (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods askLoggerIO :: SubHandlerFor child master (Loc -> LogSource -> LogLevel -> LogStr -> IO ()) #
MonadHandler (SubHandlerFor sub master) Source #
Instance details Defined in Yesod.Core.Class.Handler Associated Types type HandlerSite (SubHandlerFor sub master) :: * Source # type SubHandlerSite (SubHandlerFor sub master) :: * Source # Methods liftHandler :: HandlerFor (HandlerSite (SubHandlerFor sub master)) a -> SubHandlerFor sub master a Source # liftSubHandler :: SubHandlerFor (SubHandlerSite (SubHandlerFor sub master)) (HandlerSite (SubHandlerFor sub master)) a -> SubHandlerFor sub master a Source #
MonadReader (HandlerData child master) (SubHandlerFor child master) Source #
Instance details Defined in Yesod.Core.Types Methods ask :: SubHandlerFor child master (HandlerData child master) # local :: (HandlerData child master -> HandlerData child master) -> SubHandlerFor child master a -> SubHandlerFor child master a # reader :: (HandlerData child master -> a) -> SubHandlerFor child master a #
type HandlerSite (SubHandlerFor sub master) Source #
Instance details Defined in Yesod.Core.Class.Handler type HandlerSite (SubHandlerFor sub master) = master
type SubHandlerSite (SubHandlerFor sub master) Source #
Instance details Defined in Yesod.Core.Class.Handler type SubHandlerSite (SubHandlerFor sub master) = sub

Eq Header Source #
Instance details Defined in Yesod.Core.Types Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #
Show Header Source #
Instance details Defined in Yesod.Core.Types Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
NFData Header Source #
Instance details Defined in Yesod.Core.Types Methods rnf :: Header -> () #