| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Yesod.Core.Content
Contents
Synopsis
- data Content
- = ContentBuilder !Builder !(Maybe Int)
- | ContentSource !(ConduitT () (Flush Builder) (ResourceT IO) ())
- | ContentFile !FilePath !(Maybe FilePart)
- | ContentDontEvaluate !Content
- emptyContent :: Content
- class ToContent a where
- class ToFlushBuilder a where
- type ContentType = ByteString
- typeHtml :: ContentType
- typePlain :: ContentType
- typeJson :: ContentType
- typeXml :: ContentType
- typeAtom :: ContentType
- typeRss :: ContentType
- typeJpeg :: ContentType
- typePng :: ContentType
- typeGif :: ContentType
- typeSvg :: ContentType
- typeJavascript :: ContentType
- typeCss :: ContentType
- typeFlv :: ContentType
- typeOgv :: ContentType
- typeOctet :: ContentType
- simpleContentType :: ContentType -> ContentType
- contentTypeTypes :: ContentType -> (ByteString, ByteString)
- newtype DontFullyEvaluate a = DontFullyEvaluate {
- unDontFullyEvaluate :: a
- data TypedContent = TypedContent !ContentType !Content
- class ToContent a => ToTypedContent a where
- class ToTypedContent a => HasContentType a where
- type RepHtml = Html
- newtype RepJson = RepJson Content
- newtype RepPlain = RepPlain Content
- newtype RepXml = RepXml Content
- repJson :: ToContent a => a -> RepJson
- repPlain :: ToContent a => a -> RepPlain
- repXml :: ToContent a => a -> RepXml
Content
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 # | |
Defined in Yesod.Core.Types Methods fromString :: String -> Content # | |
| ToContent Content # | |
Defined in Yesod.Core.Content | |
| ToTypedContent (ContentType, Content) # | |
Defined in Yesod.Core.Content Methods toTypedContent :: (ContentType, Content) -> TypedContent # | |
| ToContent (ContentType, Content) # | |
Defined in Yesod.Core.Content Methods toContent :: (ContentType, Content) -> Content # | |
emptyContent :: Content #
Zero-length enumerator.
Anything which can be converted into Content. Most of the time, you will
want to use the ContentBuilder constructor. An easier approach will be to use
a pre-defined toContent function, such as converting your data into a lazy
bytestring and then calling toContent on that.
Please note that the built-in instances for lazy data structures (String,
lazy ByteString, lazy Text and Html) will not automatically include
the content length for the ContentBuilder constructor.
Minimal complete definition
Instances
class ToFlushBuilder a where #
A class for all data which can be sent in a streaming response. Note that for textual data, instances must use UTF-8 encoding.
Since 1.2.0
Minimal complete definition
Methods
toFlushBuilder :: a -> Flush Builder #
Instances
Mime types
Data type
type ContentType = ByteString #
typeHtml :: ContentType #
typeJson :: ContentType #
typeXml :: ContentType #
typeAtom :: ContentType #
typeRss :: ContentType #
typeJpeg :: ContentType #
typePng :: ContentType #
typeGif :: ContentType #
typeSvg :: ContentType #
typeCss :: ContentType #
typeFlv :: ContentType #
typeOgv :: ContentType #
Utilities
simpleContentType :: ContentType -> ContentType #
Removes "extra" information at the end of a content type string. In particular, removes everything after the semicolon, if present.
For example, "text/html; charset=utf-8" is commonly used to specify the character encoding for HTML data. This function would return "text/html".
contentTypeTypes :: ContentType -> (ByteString, ByteString) #
Give just the media types as a pair.
For example, "text/html; charset=utf-8" returns ("text", "html")
Evaluation strategy
newtype DontFullyEvaluate a #
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) # | |
Defined in Yesod.Core.Content Methods toTypedContent :: DontFullyEvaluate a -> TypedContent # | |
| HasContentType a => HasContentType (DontFullyEvaluate a) # | |
Defined in Yesod.Core.Content Methods getContentType :: Monad m => m (DontFullyEvaluate a) -> ContentType # | |
| ToContent a => ToContent (DontFullyEvaluate a) # | |
Defined in Yesod.Core.Content Methods toContent :: DontFullyEvaluate a -> Content # | |
Representations
data TypedContent #
Constructors
| TypedContent !ContentType !Content |
Instances
| ToTypedContent TypedContent # | |
Defined in Yesod.Core.Content Methods | |
| ToContent TypedContent # | |
Defined in Yesod.Core.Content Methods toContent :: TypedContent -> Content # | |
class ToContent a => ToTypedContent a where #
Any type which can be converted to TypedContent.
Since 1.2.0
Minimal complete definition
Methods
toTypedContent :: a -> TypedContent #
Instances
class ToTypedContent a => HasContentType a where #
Minimal complete definition
Methods
getContentType :: Monad m => m a -> ContentType #
Instances
Specific content types
Instances
| ToTypedContent RepJson # | |
Defined in Yesod.Core.Content Methods toTypedContent :: RepJson -> TypedContent # | |
| HasContentType RepJson # | |
Defined in Yesod.Core.Content Methods getContentType :: Monad m => m RepJson -> ContentType # | |
| ToContent RepJson # | |
Defined in Yesod.Core.Content | |
Instances
| ToTypedContent RepPlain # | |
Defined in Yesod.Core.Content Methods toTypedContent :: RepPlain -> TypedContent # | |
| HasContentType RepPlain # | |
Defined in Yesod.Core.Content Methods getContentType :: Monad m => m RepPlain -> ContentType # | |
| ToContent RepPlain # | |
Defined in Yesod.Core.Content | |
Instances
| ToTypedContent RepXml # | |
Defined in Yesod.Core.Content Methods toTypedContent :: RepXml -> TypedContent # | |
| HasContentType RepXml # | |
Defined in Yesod.Core.Content Methods getContentType :: Monad m => m RepXml -> ContentType # | |
| ToContent RepXml # | |
Defined in Yesod.Core.Content | |