Safe Haskell | None |
---|---|
Language | Haskell98 |
Yesod.Core.Types
- 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 {}
- 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 :: !(Source (ResourceT IO) ByteString)
- fileMove :: !(FilePath -> IO ())
- data FileUpload
- = FileUploadMemory !(BackEnd ByteString)
- | FileUploadDisk !(InternalState -> BackEnd FilePath)
- | FileUploadSource !(BackEnd (Source (ResourceT IO) ByteString))
- data Approot master
- = ApprootRelative
- | ApprootStatic !Text
- | ApprootMaster !(master -> Text)
- | ApprootRequest !(master -> Request -> Text)
- type ResolvedApproot = Text
- data AuthResult
- data ScriptLoadPosition master
- type BottomOfHeadAsync master = [Text] -> Maybe (HtmlUrl (Route master)) -> HtmlUrl (Route master)
- type Texts = [Text]
- newtype WaiSubsite = WaiSubsite {}
- newtype WaiSubsiteWithAuth = WaiSubsiteWithAuth {}
- data RunHandlerEnv site = RunHandlerEnv {
- rheRender :: !(Route site -> [(Text, Text)] -> Text)
- rheRoute :: !(Maybe (Route site))
- rheSite :: !site
- rheUpload :: !(RequestBodyLength -> FileUpload)
- rheLog :: !(Loc -> LogSource -> LogLevel -> LogStr -> IO ())
- rheOnError :: !(ErrorResponse -> YesodApp)
- rheMaxExpires :: !Text
- data HandlerData site parentRoute = HandlerData {
- handlerRequest :: !YesodRequest
- handlerEnv :: !(RunHandlerEnv site)
- handlerState :: !(IORef GHState)
- handlerToParent :: !(Route site -> parentRoute)
- handlerResource :: !InternalState
- data YesodRunnerEnv site = YesodRunnerEnv {
- yreLogger :: !Logger
- yreSite :: !site
- yreSessionBackend :: !(Maybe SessionBackend)
- yreGen :: !GenIO
- yreGetMaxExpires :: IO Text
- data YesodSubRunnerEnv sub parent parentMonad = YesodSubRunnerEnv {
- ysreParentRunner :: !(ParentRunner parent parentMonad)
- ysreGetSub :: !(parent -> sub)
- ysreToParentRoute :: !(Route sub -> Route parent)
- ysreParentEnv :: !(YesodRunnerEnv parent)
- type ParentRunner parent m = m TypedContent -> YesodRunnerEnv parent -> Maybe (Route parent) -> Application
- newtype HandlerT site m a = HandlerT {
- unHandlerT :: HandlerData site (MonadRoute m) -> m a
- type family MonadRoute (m :: * -> *)
- data GHState = GHState {
- ghsSession :: SessionMap
- ghsRBC :: Maybe RequestBodyContents
- ghsIdent :: Int
- ghsCache :: TypeMap
- ghsCacheBy :: KeyedTypeMap
- ghsHeaders :: Endo [Header]
- type YesodApp = YesodRequest -> ResourceT IO YesodResponse
- newtype WidgetT site m a = WidgetT {
- unWidgetT :: HandlerData site (MonadRoute m) -> m (a, GWData (Route site))
- type RY master = Route master -> [(Text, Text)] -> Text
- newtype CssBuilder = CssBuilder {}
- data PageContent url = PageContent {}
- data Content
- = ContentBuilder !Builder !(Maybe Int)
- | ContentSource !(Source (ResourceT IO) (Flush Builder))
- | 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
- data Header
- data Location url
- 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 {}
- 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
- data Logger = Logger {}
- loggerPutStr :: Logger -> LogStr -> IO ()
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
|
data SessionCookie Source #
Constructors
SessionCookie (Either UTCTime ByteString) ByteString SessionMap |
Instances
data ClientSessionDateCache Source #
Constructors
ClientSessionDateCache | |
Fields
|
Instances
data YesodRequest Source #
The parsed request information. This type augments the standard WAI
Request
with additional information.
Constructors
YesodRequest | |
Fields
|
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.
Constructors
FileInfo | |
Fields
|
data FileUpload Source #
Constructors
FileUploadMemory !(BackEnd ByteString) | |
FileUploadDisk !(InternalState -> BackEnd FilePath) | |
FileUploadSource !(BackEnd (Source (ResourceT IO) ByteString)) |
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 ScriptLoadPosition master Source #
Constructors
BottomOfBody | |
BottomOfHeadBlocking | |
BottomOfHeadAsync (BottomOfHeadAsync master) |
type BottomOfHeadAsync master Source #
newtype WaiSubsite Source #
Wrap up a normal WAI application as a Yesod subsite. Ignore parent site's middleware and isAuthorized.
Constructors
WaiSubsite | |
Fields |
Instances
ParseRoute WaiSubsite Source # | |
RenderRoute WaiSubsite Source # | |
YesodSubDispatch WaiSubsite master Source # | |
Eq (Route WaiSubsite) Source # | |
Ord (Route WaiSubsite) Source # | |
Read (Route WaiSubsite) Source # | |
Show (Route WaiSubsite) Source # | |
data Route WaiSubsite Source # | |
newtype WaiSubsiteWithAuth Source #
Like WaiSubsite
, but applies parent site's middleware and isAuthorized.
Since: 1.4.34
Constructors
WaiSubsiteWithAuth | |
Fields |
Instances
data RunHandlerEnv site Source #
Constructors
RunHandlerEnv | |
Fields
|
data HandlerData site parentRoute Source #
Constructors
HandlerData | |
Fields
|
data YesodRunnerEnv site Source #
Constructors
YesodRunnerEnv | |
Fields
|
data YesodSubRunnerEnv sub parent parentMonad Source #
Constructors
YesodSubRunnerEnv | |
Fields
|
type ParentRunner parent m = m TypedContent -> YesodRunnerEnv parent -> Maybe (Route parent) -> Application Source #
newtype HandlerT site m a Source #
A generic handler monad, which can have a different subsite and master site. We define a newtype for better error message.
Constructors
HandlerT | |
Fields
|
Instances
MonadBaseControl b m => MonadBaseControl b (HandlerT site m) Source # | Note: although we provide a Using fork usually leads to an exception that says "Control.Monad.Trans.Resource.register': The mutable state is being accessed after cleanup. Please contact the maintainers." |
MonadBase b m => MonadBase b (HandlerT site m) Source # | |
Monad m => MonadReader site (HandlerT site m) Source # | |
YesodSubDispatch WaiSubsiteWithAuth (HandlerT master IO) Source # | |
MonadTrans (HandlerT site) Source # | |
Monad m => Monad (HandlerT site m) Source # | |
Monad m => Functor (HandlerT site m) Source # | |
Monad m => Applicative (HandlerT site m) Source # | |
MonadIO m => MonadIO (HandlerT site m) Source # | |
MonadActive m => MonadActive (HandlerT site m) Source # | |
MonadThrow m => MonadThrow (HandlerT site m) Source # | |
MonadCatch m => MonadCatch (HandlerT site m) Source # | |
MonadMask m => MonadMask (HandlerT site m) Source # | |
MonadIO m => MonadLogger (HandlerT site m) Source # | |
MonadIO m => MonadLoggerIO (HandlerT site m) Source # | |
(MonadIO m, MonadBase IO m, MonadThrow m) => MonadResource (HandlerT site m) Source # | |
MonadResourceBase m => MonadHandler (HandlerT site m) Source # | |
type MonadRoute (HandlerT site m) Source # | |
type HandlerSite (HandlerT site m) Source # | |
type StM (HandlerT site m) a Source # | |
type family MonadRoute (m :: * -> *) Source #
Instances
type MonadRoute IO Source # | |
type MonadRoute (HandlerT site m) Source # | |
Constructors
GHState | |
Fields
|
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 WidgetT site m 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
WidgetT | |
Fields
|
Instances
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 |
Instances
ToWidgetHead site CssBuilder Source # | |
ToWidgetMedia site CssBuilder Source # | |
ToWidget site CssBuilder Source # | |
(~) * render (RY site) => ToWidgetHead site (render -> CssBuilder) Source # | |
(~) * render (RY site) => ToWidgetMedia site (render -> CssBuilder) Source # | |
(~) * render (RY site) => ToWidget site (render -> CssBuilder) 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
ContentBuilder !Builder !(Maybe Int) | The content and optional content length. |
ContentSource !(Source (ResourceT IO) (Flush Builder)) | |
ContentFile !FilePath !(Maybe FilePart) | |
ContentDontEvaluate !Content |
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
|
Instances
ToTypedContent a => ToTypedContent (DontFullyEvaluate a) Source # | |
HasContentType a => HasContentType (DontFullyEvaluate a) Source # | |
ToContent a => ToContent (DontFullyEvaluate a) 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
Headers to be added to a Result
.
Constructors
AddCookie SetCookie | |
DeleteCookie ByteString ByteString | |
Header ByteString ByteString |
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 # | |
Monoid (UniqueList x) Source # | |
Constructors
Script | |
Fields
|
data Stylesheet url Source #
Constructors
Stylesheet | |
Fields
|
Instances
Eq url => Eq (Stylesheet url) Source # | |
Show url => Show (Stylesheet url) Source # | |
Constructors
GWData | |
Fields
|
data HandlerContents Source #
Constructors
HCContent Status !TypedContent | |
HCError ErrorResponse | |
HCSendFile ContentType FilePath (Maybe FilePart) | |
HCRedirect Status Text | |
HCCreated Text | |
HCWai Response | |
HCWaiApp Application |
Instances
Constructors
Logger | |
Fields
|