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 :: !(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
  • = 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
  }
• 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)
  • rheGetMaxExpires :: IO 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
  }
• 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 {
  • unCssBuilder :: Builder
  }
• data PageContent url = PageContent {
  • pageTitle :: Html
  • pageHead :: HtmlUrl url
  • pageBody :: HtmlUrl url
  }
• 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
  • = NotFound
  • | InternalError Text
  • | InvalidArgs [Text]
  • | NotAuthenticated
  • | PermissionDenied Text
  • | BadMethod Method
• data Header
  • = AddCookie SetCookie
  • | DeleteCookie ByteString ByteString
  • | Header 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 ()

Documentation

getHomeR = do defaultLayout "Widget text"

toWidget $ CssBuilder "p { color: red }"

PageContent url -> HtmlUrl url