Safe Haskell	None
Language	Haskell98

Yesod.Core.Content

Contents

Content
Mime types
- Data type
Utilities
Evaluation strategy
Representations
- Specific content types
- Smart constructors

Synopsis

Content

data Content Source

Constructors

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

Instances

IsString Content Source
ToContent Content Source
ToTypedContent (ContentType, Content) Source
ToContent (ContentType, Content) Source

emptyContent :: Content Source

Zero-length enumerator.

class ToContent a where Source

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.

Methods

toContent :: a -> Content Source

Instances

ToContent String Source
ToContent () Source
ToContent ByteString Source
ToContent ByteString Source
ToContent Text Source
ToContent Builder Source
ToContent Text Source
ToContent Html Source
ToContent Value Source
ToContent Javascript Source
ToContent Encoding Source
ToContent RepXml Source
ToContent RepPlain Source
ToContent RepJson Source
ToContent TypedContent Source
ToContent Content Source
ToContent Css Source
ToContent a => ToContent (DontFullyEvaluate a) Source
ToContent (ContentType, Content) Source
ToFlushBuilder builder => ToContent (Source (ResourceT IO) builder) Source
ToFlushBuilder builder => ToContent (ResumableSource (ResourceT IO) builder) Source
ToFlushBuilder builder => ToContent (Pipe () () builder () (ResourceT IO) ()) Source

class ToFlushBuilder a where Source

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

Methods

toFlushBuilder :: a -> Flush Builder Source

Instances

ToFlushBuilder String Source
ToFlushBuilder ByteString Source
ToFlushBuilder ByteString Source
ToFlushBuilder Text Source
ToFlushBuilder Builder Source
ToFlushBuilder Text Source
ToFlushBuilder Html Source
ToFlushBuilder (Flush String) Source
ToFlushBuilder (Flush ByteString) Source
ToFlushBuilder (Flush ByteString) Source
ToFlushBuilder (Flush Text) Source
ToFlushBuilder (Flush Builder) Source
ToFlushBuilder (Flush Text) Source
ToFlushBuilder (Flush Html) Source

Mime types

Data type

type ContentType = ByteString Source

typeHtml :: ContentType Source

typePlain :: ContentType Source

typeJson :: ContentType Source

typeXml :: ContentType Source

typeAtom :: ContentType Source

typeRss :: ContentType Source

typeJpeg :: ContentType Source

typePng :: ContentType Source

typeGif :: ContentType Source

typeSvg :: ContentType Source

typeJavascript :: ContentType Source

typeCss :: ContentType Source

typeFlv :: ContentType Source

typeOgv :: ContentType Source

typeOctet :: ContentType Source

Utilities

simpleContentType :: ContentType -> ContentType Source

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) Source

Evaluation strategy

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
HasContentType a => HasContentType (DontFullyEvaluate a) Source
ToContent a => ToContent (DontFullyEvaluate a) Source

Representations

data TypedContent Source

Constructors

TypedContent !ContentType !Content

Instances

ToTypedContent TypedContent Source
ToContent TypedContent Source

class ToContent a => ToTypedContent a where Source

Any type which can be converted to TypedContent.

Since 1.2.0

Methods

toTypedContent :: a -> TypedContent Source

class ToTypedContent a => HasContentType a where Source

Methods

getContentType :: Monad m => m a -> ContentType Source

Instances

HasContentType Text Source
HasContentType Text Source
HasContentType Html Source
HasContentType Value Source
HasContentType Javascript Source
HasContentType Encoding Source
HasContentType RepXml Source
HasContentType RepPlain Source
HasContentType RepJson Source
HasContentType Css Source
HasContentType a => HasContentType (DontFullyEvaluate a) Source

Specific content types

type RepHtml = Html Source

Deprecated: Please use Html instead

newtype RepJson Source

Constructors

RepJson Content

Instances

ToTypedContent RepJson Source
HasContentType RepJson Source
ToContent RepJson Source

newtype RepPlain Source

Constructors

RepPlain Content

Instances

ToTypedContent RepPlain Source
HasContentType RepPlain Source
ToContent RepPlain Source

newtype RepXml Source

Constructors

RepXml Content

Instances

ToTypedContent RepXml Source
HasContentType RepXml Source
ToContent RepXml Source

Smart constructors

repJson :: ToContent a => a -> RepJson Source

repPlain :: ToContent a => a -> RepPlain Source

repXml :: ToContent a => a -> RepXml Source

ToTypedContent () Source
ToTypedContent Text Source
ToTypedContent Text Source
ToTypedContent Html Source
ToTypedContent Value Source
ToTypedContent Javascript Source
ToTypedContent Encoding Source
ToTypedContent RepXml Source
ToTypedContent RepPlain Source
ToTypedContent RepJson Source
ToTypedContent TypedContent Source
ToTypedContent Css Source
ToTypedContent [Char] Source
ToTypedContent a => ToTypedContent (DontFullyEvaluate a) Source
ToTypedContent (ContentType, Content) Source