Safe Haskell | None |
---|
Snap.Internal.Http.Types
Description
An internal Snap module containing HTTP types.
N.B. this is an internal interface, please don't write user code that depends on it. Most of these declarations (except for the unsafe/encapsulation-breaking ones) are re-exported from Snap.Core.
- class HasHeaders a where
- updateHeaders :: (Headers -> Headers) -> a -> a
- headers :: a -> Headers
- addHeader :: HasHeaders a => CI ByteString -> ByteString -> a -> a
- setHeader :: HasHeaders a => CI ByteString -> ByteString -> a -> a
- getHeaders :: HasHeaders a => CI ByteString -> a -> Maybe [ByteString]
- getHeader :: HasHeaders a => CI ByteString -> a -> Maybe ByteString
- listHeaders :: HasHeaders a => a -> [(CI ByteString, ByteString)]
- deleteHeader :: HasHeaders a => CI ByteString -> a -> a
- data Method
- type HttpVersion = (Int, Int)
- data Cookie = Cookie {
- cookieName :: !ByteString
- cookieValue :: !ByteString
- cookieExpires :: !(Maybe UTCTime)
- cookieDomain :: !(Maybe ByteString)
- cookiePath :: !(Maybe ByteString)
- cookieSecure :: !Bool
- cookieHttpOnly :: !Bool
- type Params = Map ByteString [ByteString]
- newtype SomeEnumerator = SomeEnumerator (forall a. Enumerator ByteString IO a)
- data Request = Request {
- rqServerName :: ByteString
- rqServerPort :: !Int
- rqRemoteAddr :: ByteString
- rqRemotePort :: Int
- rqLocalAddr :: ByteString
- rqLocalPort :: Int
- rqLocalHostname :: ByteString
- rqIsSecure :: Bool
- rqHeaders :: Headers
- rqBody :: !(IORef SomeEnumerator)
- rqContentLength :: !(Maybe Int)
- rqMethod :: !Method
- rqVersion :: HttpVersion
- rqCookies :: [Cookie]
- rqPathInfo :: !ByteString
- rqContextPath :: !ByteString
- rqURI :: !ByteString
- rqQueryString :: !ByteString
- rqParams :: Params
- rqQueryParams :: Params
- rqPostParams :: Params
- data ResponseBody
- = Enum (forall a. Enumerator Builder IO a)
- | SendFile FilePath (Maybe (Int64, Int64))
- rspBodyMap :: (forall a. Enumerator Builder IO a -> Enumerator Builder IO a) -> ResponseBody -> ResponseBody
- rspBodyToEnum :: ResponseBody -> Enumerator Builder IO a
- data Response = Response {
- rspHeaders :: Headers
- rspCookies :: Map ByteString Cookie
- rspHttpVersion :: !HttpVersion
- rspContentLength :: !(Maybe Int64)
- rspBody :: ResponseBody
- rspStatus :: !Int
- rspStatusReason :: !ByteString
- rspTransformingRqBody :: !Bool
- rspOutputBuffering :: !Bool
- rqParam :: ByteString -> Request -> Maybe [ByteString]
- rqPostParam :: ByteString -> Request -> Maybe [ByteString]
- rqQueryParam :: ByteString -> Request -> Maybe [ByteString]
- rqModifyParams :: (Params -> Params) -> Request -> Request
- rqSetParam :: ByteString -> [ByteString] -> Request -> Request
- emptyResponse :: Response
- setResponseBody :: (forall a. Enumerator Builder IO a) -> Response -> Response
- setResponseStatus :: Int -> ByteString -> Response -> Response
- setResponseCode :: Int -> Response -> Response
- modifyResponseBody :: (forall a. Enumerator Builder IO a -> Enumerator Builder IO a) -> Response -> Response
- setContentType :: ByteString -> Response -> Response
- addResponseCookie :: Cookie -> Response -> Response
- getResponseCookie :: ByteString -> Response -> Maybe Cookie
- getResponseCookies :: Response -> [Cookie]
- deleteResponseCookie :: ByteString -> Response -> Response
- modifyResponseCookie :: ByteString -> (Cookie -> Cookie) -> Response -> Response
- setContentLength :: Int64 -> Response -> Response
- clearContentLength :: Response -> Response
- getBufferingMode :: Response -> Bool
- setBufferingMode :: Bool -> Response -> Response
- formatHttpTime :: CTime -> IO ByteString
- formatLogTime :: CTime -> IO ByteString
- parseHttpTime :: ByteString -> IO CTime
- fromStr :: String -> ByteString
- toStr :: ByteString -> String
- statusReasonMap :: IntMap ByteString
Documentation
class HasHeaders a where
A typeclass for datatypes which contain HTTP headers.
Methods
updateHeaders :: (Headers -> Headers) -> a -> a
Modify the datatype's headers.
Retrieve the headers from a datatype that has headers.
Instances
addHeader :: HasHeaders a => CI ByteString -> ByteString -> a -> a
Adds a header key-value-pair to the HasHeaders
datatype. If a header
with the same name already exists, the new value is appended to the headers
list.
setHeader :: HasHeaders a => CI ByteString -> ByteString -> a -> a
Sets a header key-value-pair in a HasHeaders
datatype. If a header with
the same name already exists, it is overwritten with the new value.
getHeaders :: HasHeaders a => CI ByteString -> a -> Maybe [ByteString]
Gets all of the values for a given header.
getHeader :: HasHeaders a => CI ByteString -> a -> Maybe ByteString
Gets a header value out of a HasHeaders
datatype. If many headers came
in with the same name, they will be catenated together.
listHeaders :: HasHeaders a => a -> [(CI ByteString, ByteString)]
Lists all the headers out of a HasHeaders
datatype. If many
headers came in with the same name, they will be catenated together.
deleteHeader :: HasHeaders a => CI ByteString -> a -> a
Clears a header value from a HasHeaders
datatype.
data Method
Enumerates the HTTP method values (see http://tools.ietf.org/html/rfc2068.html#section-5.1.1).
type HttpVersion = (Int, Int)
data Cookie
A datatype representing an HTTP cookie.
Constructors
Cookie | |
Fields
|
type Params = Map ByteString [ByteString]
A type alias for the HTTP parameters mapping. Each parameter
key maps to a list of ByteString values; if a parameter is specified
multiple times (e.g.: "GET /foo?param=bar1¶m=bar2
"), looking up
"param
" in the mapping will give you ["bar1", "bar2"]
.
newtype SomeEnumerator
An existential wrapper for the 'Enumerator ByteString IO a' type
Constructors
SomeEnumerator (forall a. Enumerator ByteString IO a) |
data Request
Contains all of the information about an incoming HTTP request.
Constructors
Request | |
Fields
|
Instances
Show Request | |
HasHeaders Request | |
Monad m => MonadState Request (RequestBuilder m) |
data ResponseBody
Constructors
Enum (forall a. Enumerator Builder IO a) | output body is a |
SendFile FilePath (Maybe (Int64, Int64)) | output body is sendfile(), optional second argument is a byte range to send |
rspBodyMap :: (forall a. Enumerator Builder IO a -> Enumerator Builder IO a) -> ResponseBody -> ResponseBody
rspBodyToEnum :: ResponseBody -> Enumerator Builder IO a
data Response
Represents an HTTP response.
Constructors
Response | |
Fields
|
Instances
Show Response | |
HasHeaders Response |
Arguments
:: ByteString | parameter name to look up |
-> Request | HTTP request |
-> Maybe [ByteString] |
Looks up the value(s) for the given named parameter. Parameters initially
come from the request's query string and any decoded POST body (if the
request's Content-Type
is application/x-www-form-urlencoded
).
Parameter values can be modified within handlers using rqModifyParams.
Arguments
:: ByteString | parameter name to look up |
-> Request | HTTP request |
-> Maybe [ByteString] |
Looks up the value(s) for the given named parameter in the POST parameters mapping.
Arguments
:: ByteString | parameter name to look up |
-> Request | HTTP request |
-> Maybe [ByteString] |
Looks up the value(s) for the given named parameter in the query parameters mapping.
rqModifyParams :: (Params -> Params) -> Request -> Request
Modifies the parameters mapping (which is a Map ByteString ByteString
)
in a Request
using the given function.
Writes a key-value pair to the parameters mapping within the given request.
An empty Response
.
Arguments
:: (forall a. Enumerator Builder IO a) | new response body enumerator |
-> Response | response to modify |
-> Response |
Sets an HTTP response body to the given Enumerator
value.
Arguments
:: Int | HTTP response integer code |
-> ByteString | HTTP response explanation |
-> Response | Response to be modified |
-> Response |
Sets the HTTP response status. Note: normally you would use
setResponseCode
unless you needed a custom response explanation.
Sets the HTTP response code.
modifyResponseBody :: (forall a. Enumerator Builder IO a -> Enumerator Builder IO a) -> Response -> Response
Modifies a response body.
setContentType :: ByteString -> Response -> Response
Sets the Content-Type
in the Response
headers.
setContentLength :: Int64 -> Response -> Response
A note here: if you want to set the Content-Length
for the response,
Snap forces you to do it with this function rather than by setting it in
the headers; the Content-Length
in the headers will be ignored.
The reason for this is that Snap needs to look up the value of
Content-Length
for each request, and looking the string value up in the
headers and parsing the number out of the text will be too expensive.
If you don't set a content length in your response, HTTP keep-alive will be
disabled for HTTP/1.0 clients, forcing a Connection: close
. For
HTTP/1.1 clients, Snap will switch to the chunked transfer encoding if
Content-Length
is not specified.
clearContentLength :: Response -> Response
Removes any Content-Length
set in the Response
.
getBufferingMode :: Response -> Bool
The buffering mode controls whether Snap will buffer the output or not. You may wish to disable buffering when using Comet-like techniques which rely on the immediate sending of output data in order to maintain interactive semantics.
Arguments
:: Bool | if True, buffer the output, if False, send output immediately |
-> Response | |
-> Response |
The buffering mode controls whether Snap will buffer the output or not. You may wish to disable buffering when using Comet-like techniques which rely on the immediate sending of output data in order to maintain interactive semantics.
formatHttpTime :: CTime -> IO ByteString
Converts a CTime
into an HTTP timestamp.
formatLogTime :: CTime -> IO ByteString
Converts a CTime
into common log entry format.
parseHttpTime :: ByteString -> IO CTime
Converts an HTTP timestamp into a CTime
.
fromStr :: String -> ByteString
toStr :: ByteString -> String
statusReasonMap :: IntMap ByteString