-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Web Application Interface.
--   
--   API docs and the README are available at
--   <a>http://www.stackage.org/package/wai</a>.
@package wai
@version 3.2.0.1


-- | Internal constructors and helper functions. Note that no guarantees
--   are given for stability of these interfaces.
module Network.Wai.Internal

-- | Information on the request sent by the client. This abstracts away the
--   details of the underlying implementation.
data Request
Request :: Method -> HttpVersion -> ByteString -> ByteString -> RequestHeaders -> Bool -> SockAddr -> [Text] -> Query -> IO ByteString -> Vault -> RequestBodyLength -> Maybe ByteString -> Maybe ByteString -> Maybe ByteString -> Maybe ByteString -> Request

-- | Request method such as GET.
[requestMethod] :: Request -> Method

-- | HTTP version such as 1.1.
[httpVersion] :: Request -> HttpVersion

-- | Extra path information sent by the client. The meaning varies slightly
--   depending on backend; in a standalone server setting, this is most
--   likely all information after the domain name. In a CGI application,
--   this would be the information following the path to the CGI executable
--   itself.
--   
--   Middlewares and routing tools should not modify this raw value, as it
--   may be used for such things as creating redirect destinations by
--   applications. Instead, if you are writing a middleware or routing
--   framework, modify the <tt>pathInfo</tt> instead. This is the approach
--   taken by systems like Yesod subsites.
--   
--   <i>Note</i>: At the time of writing this documentation, there is at
--   least one system (<tt>Network.Wai.UrlMap</tt> from <tt>wai-extra</tt>)
--   that does not follow the above recommendation. Therefore, it is
--   recommended that you test the behavior of your application when using
--   <tt>rawPathInfo</tt> and any form of library that might modify the
--   <tt>Request</tt>.
[rawPathInfo] :: Request -> ByteString

-- | If no query string was specified, this should be empty. This value
--   <i>will</i> include the leading question mark. Do not modify this raw
--   value - modify queryString instead.
[rawQueryString] :: Request -> ByteString

-- | A list of headers (a pair of key and value) in an HTTP request.
[requestHeaders] :: Request -> RequestHeaders

-- | Was this request made over an SSL connection?
--   
--   Note that this value will <i>not</i> tell you if the client originally
--   made this request over SSL, but rather whether the current connection
--   is SSL. The distinction lies with reverse proxies. In many cases, the
--   client will connect to a load balancer over SSL, but connect to the
--   WAI handler without SSL. In such a case, <a>isSecure</a> will be
--   <a>False</a>, but from a user perspective, there is a secure
--   connection.
[isSecure] :: Request -> Bool

-- | The client's host information.
[remoteHost] :: Request -> SockAddr

-- | Path info in individual pieces - the URL without a hostname/port and
--   without a query string, split on forward slashes.
[pathInfo] :: Request -> [Text]

-- | Parsed query string information.
[queryString] :: Request -> Query

-- | Get the next chunk of the body. Returns <a>empty</a> when the body is
--   fully consumed.
[requestBody] :: Request -> IO ByteString

-- | A location for arbitrary data to be shared by applications and
--   middleware.
[vault] :: Request -> Vault

-- | The size of the request body. In the case of a chunked request body,
--   this may be unknown.
--   
--   Since 1.4.0
[requestBodyLength] :: Request -> RequestBodyLength

-- | The value of the Host header in a HTTP request.
--   
--   Since 2.0.0
[requestHeaderHost] :: Request -> Maybe ByteString

-- | The value of the Range header in a HTTP request.
--   
--   Since 2.0.0
[requestHeaderRange] :: Request -> Maybe ByteString

-- | The value of the Referer header in a HTTP request.
--   
--   Since 3.2.0
[requestHeaderReferer] :: Request -> Maybe ByteString

-- | The value of the User-Agent header in a HTTP request.
--   
--   Since 3.2.0
[requestHeaderUserAgent] :: Request -> Maybe ByteString
data Response
ResponseFile :: Status -> ResponseHeaders -> FilePath -> (Maybe FilePart) -> Response
ResponseBuilder :: Status -> ResponseHeaders -> Builder -> Response
ResponseStream :: Status -> ResponseHeaders -> StreamingBody -> Response
ResponseRaw :: (IO ByteString -> (ByteString -> IO ()) -> IO ()) -> Response -> Response

-- | Represents a streaming HTTP response body. It's a function of two
--   parameters; the first parameter provides a means of sending another
--   chunk of data, and the second parameter provides a means of flushing
--   the data to the client.
--   
--   Since 3.0.0
type StreamingBody = (Builder -> IO ()) -> IO () -> IO ()

-- | The size of the request body. In the case of chunked bodies, the size
--   will not be known.
--   
--   Since 1.4.0
data RequestBodyLength
ChunkedBody :: RequestBodyLength
KnownLength :: Word64 -> RequestBodyLength

-- | Information on which part to be sent. Sophisticated application
--   handles Range (and If-Range) then create <a>FilePart</a>.
data FilePart
FilePart :: Integer -> Integer -> Integer -> FilePart
[filePartOffset] :: FilePart -> Integer
[filePartByteCount] :: FilePart -> Integer
[filePartFileSize] :: FilePart -> Integer

-- | A special datatype to indicate that the WAI handler has received the
--   response. This is to avoid the need for Rank2Types in the definition
--   of Application.
--   
--   It is <i>highly</i> advised that only WAI handlers import and use the
--   data constructor for this data type.
--   
--   Since 3.0.0
data ResponseReceived
ResponseReceived :: ResponseReceived
instance GHC.Show.Show Network.Wai.Internal.FilePart
instance GHC.Show.Show Network.Wai.Internal.RequestBodyLength
instance GHC.Show.Show Network.Wai.Internal.Request


-- | This module defines a generic web application interface. It is a
--   common protocol between web servers and web applications.
--   
--   The overriding design principles here are performance and generality.
--   To address performance, this library is built on top of the conduit
--   and blaze-builder packages. The advantages of conduits over lazy IO
--   have been debated elsewhere and so will not be addressed here.
--   However, helper functions like <a>responseLBS</a> allow you to
--   continue using lazy IO if you so desire.
--   
--   Generality is achieved by removing many variables commonly found in
--   similar projects that are not universal to all servers. The goal is
--   that the <a>Request</a> object contains only data which is meaningful
--   in all circumstances.
--   
--   Please remember when using this package that, while your application
--   may compile without a hitch against many different servers, there are
--   other considerations to be taken when moving to a new backend. For
--   example, if you transfer from a CGI application to a FastCGI one, you
--   might suddenly find you have a memory leak. Conversely, a FastCGI
--   application would be well served to preload all templates from disk
--   when first starting; this would kill the performance of a CGI
--   application.
--   
--   This package purposely provides very little functionality. You can
--   find various middlewares, backends and utilities on Hackage. Some of
--   the most commonly used include:
--   
--   <ul>
--   <li><i>warp</i> <a>http://hackage.haskell.org/package/warp</a></li>
--   <li><i>wai-extra</i>
--   <a>http://hackage.haskell.org/package/wai-extra</a></li>
--   <li><i>wai-test</i>
--   <a>http://hackage.haskell.org/package/wai-test</a></li>
--   </ul>
module Network.Wai

-- | The WAI application.
--   
--   Note that, since WAI 3.0, this type is structured in continuation
--   passing style to allow for proper safe resource handling. This was
--   handled in the past via other means (e.g., <tt>ResourceT</tt>). As a
--   demonstration:
--   
--   <pre>
--   app :: Application
--   app req respond = bracket_
--       (putStrLn "Allocating scarce resource")
--       (putStrLn "Cleaning up")
--       (respond $ responseLBS status200 [] "Hello World")
--   </pre>
type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived

-- | Middleware is a component that sits between the server and
--   application. It can do such tasks as GZIP encoding or response
--   caching. What follows is the general definition of middleware, though
--   a middleware author should feel free to modify this.
--   
--   As an example of an alternate type for middleware, suppose you write a
--   function to load up session information. The session information is
--   simply a string map [(String, String)]. A logical type signature for
--   this middleware might be:
--   
--   <pre>
--   loadSession :: ([(String, String)] -&gt; Application) -&gt; Application
--   </pre>
--   
--   Here, instead of taking a standard <a>Application</a> as its first
--   argument, the middleware takes a function which consumes the session
--   information as well.
type Middleware = Application -> Application

-- | A special datatype to indicate that the WAI handler has received the
--   response. This is to avoid the need for Rank2Types in the definition
--   of Application.
--   
--   It is <i>highly</i> advised that only WAI handlers import and use the
--   data constructor for this data type.
--   
--   Since 3.0.0
data ResponseReceived

-- | Information on the request sent by the client. This abstracts away the
--   details of the underlying implementation.
data Request

-- | A default, blank request.
--   
--   Since 2.0.0
defaultRequest :: Request

-- | The size of the request body. In the case of chunked bodies, the size
--   will not be known.
--   
--   Since 1.4.0
data RequestBodyLength
ChunkedBody :: RequestBodyLength
KnownLength :: Word64 -> RequestBodyLength

-- | Request method such as GET.
requestMethod :: Request -> Method

-- | HTTP version such as 1.1.
httpVersion :: Request -> HttpVersion

-- | Extra path information sent by the client. The meaning varies slightly
--   depending on backend; in a standalone server setting, this is most
--   likely all information after the domain name. In a CGI application,
--   this would be the information following the path to the CGI executable
--   itself.
--   
--   Middlewares and routing tools should not modify this raw value, as it
--   may be used for such things as creating redirect destinations by
--   applications. Instead, if you are writing a middleware or routing
--   framework, modify the <tt>pathInfo</tt> instead. This is the approach
--   taken by systems like Yesod subsites.
--   
--   <i>Note</i>: At the time of writing this documentation, there is at
--   least one system (<tt>Network.Wai.UrlMap</tt> from <tt>wai-extra</tt>)
--   that does not follow the above recommendation. Therefore, it is
--   recommended that you test the behavior of your application when using
--   <tt>rawPathInfo</tt> and any form of library that might modify the
--   <tt>Request</tt>.
rawPathInfo :: Request -> ByteString

-- | If no query string was specified, this should be empty. This value
--   <i>will</i> include the leading question mark. Do not modify this raw
--   value - modify queryString instead.
rawQueryString :: Request -> ByteString

-- | A list of headers (a pair of key and value) in an HTTP request.
requestHeaders :: Request -> RequestHeaders

-- | Was this request made over an SSL connection?
--   
--   Note that this value will <i>not</i> tell you if the client originally
--   made this request over SSL, but rather whether the current connection
--   is SSL. The distinction lies with reverse proxies. In many cases, the
--   client will connect to a load balancer over SSL, but connect to the
--   WAI handler without SSL. In such a case, <a>isSecure</a> will be
--   <a>False</a>, but from a user perspective, there is a secure
--   connection.
isSecure :: Request -> Bool

-- | The client's host information.
remoteHost :: Request -> SockAddr

-- | Path info in individual pieces - the URL without a hostname/port and
--   without a query string, split on forward slashes.
pathInfo :: Request -> [Text]

-- | Parsed query string information.
queryString :: Request -> Query

-- | Get the next chunk of the body. Returns <a>empty</a> when the body is
--   fully consumed.
requestBody :: Request -> IO ByteString

-- | A location for arbitrary data to be shared by applications and
--   middleware.
vault :: Request -> Vault

-- | The size of the request body. In the case of a chunked request body,
--   this may be unknown.
--   
--   Since 1.4.0
requestBodyLength :: Request -> RequestBodyLength

-- | The value of the Host header in a HTTP request.
--   
--   Since 2.0.0
requestHeaderHost :: Request -> Maybe ByteString

-- | The value of the Range header in a HTTP request.
--   
--   Since 2.0.0
requestHeaderRange :: Request -> Maybe ByteString

-- | The value of the Referer header in a HTTP request.
--   
--   Since 3.2.0
requestHeaderReferer :: Request -> Maybe ByteString

-- | The value of the User-Agent header in a HTTP request.
--   
--   Since 3.2.0
requestHeaderUserAgent :: Request -> Maybe ByteString

-- | Get the request body as a lazy ByteString. However, do <i>not</i> use
--   any lazy I/O, instead reading the entire body into memory strictly.
--   
--   Since 3.0.1
strictRequestBody :: Request -> IO ByteString

-- | Get the request body as a lazy ByteString. This uses lazy I/O under
--   the surface, and therefore all typical warnings regarding lazy I/O
--   apply.
--   
--   Since 1.4.1
lazyRequestBody :: Request -> IO ByteString
data Response

-- | Represents a streaming HTTP response body. It's a function of two
--   parameters; the first parameter provides a means of sending another
--   chunk of data, and the second parameter provides a means of flushing
--   the data to the client.
--   
--   Since 3.0.0
type StreamingBody = (Builder -> IO ()) -> IO () -> IO ()

-- | Information on which part to be sent. Sophisticated application
--   handles Range (and If-Range) then create <a>FilePart</a>.
data FilePart
FilePart :: Integer -> Integer -> Integer -> FilePart
[filePartOffset] :: FilePart -> Integer
[filePartByteCount] :: FilePart -> Integer
[filePartFileSize] :: FilePart -> Integer

-- | Creating <a>Response</a> from a file.
responseFile :: Status -> ResponseHeaders -> FilePath -> Maybe FilePart -> Response

-- | Creating <a>Response</a> from <a>Builder</a>.
--   
--   Some questions and answers about the usage of <a>Builder</a> here:
--   
--   Q1. Shouldn't it be at the user's discretion to use Builders
--   internally and then create a stream of ByteStrings?
--   
--   A1. That would be less efficient, as we wouldn't get cheap
--   concatenation with the response headers.
--   
--   Q2. Isn't it really inefficient to convert from ByteString to Builder,
--   and then right back to ByteString?
--   
--   A2. No. If the ByteStrings are small, then they will be copied into a
--   larger buffer, which should be a performance gain overall (less system
--   calls). If they are already large, then blaze-builder uses an
--   InsertByteString instruction to avoid copying.
--   
--   Q3. Doesn't this prevent us from creating comet-style servers, since
--   data will be cached?
--   
--   A3. You can force blaze-builder to output a ByteString before it is an
--   optimal size by sending a flush command.
responseBuilder :: Status -> ResponseHeaders -> Builder -> Response

-- | Creating <a>Response</a> from <a>ByteString</a>. This is a wrapper for
--   <a>responseBuilder</a>.
responseLBS :: Status -> ResponseHeaders -> ByteString -> Response

-- | Creating <a>Response</a> from a stream of values.
--   
--   In order to allocate resources in an exception-safe manner, you can
--   use the <tt>bracket</tt> pattern outside of the call to
--   <tt>responseStream</tt>. As a trivial example:
--   
--   <pre>
--   app :: Application
--   app req respond = bracket_
--       (putStrLn "Allocating scarce resource")
--       (putStrLn "Cleaning up")
--       $ respond $ responseStream status200 [] $ \write flush -&gt; do
--           write $ fromByteString "Hello\n"
--           flush
--           write $ fromByteString "World\n"
--   </pre>
--   
--   Note that in some cases you can use <tt>bracket</tt> from inside
--   <tt>responseStream</tt> as well. However, placing the call on the
--   outside allows your status value and response headers to depend on the
--   scarce resource.
--   
--   Since 3.0.0
responseStream :: Status -> ResponseHeaders -> StreamingBody -> Response

-- | Create a response for a raw application. This is useful for "upgrade"
--   situations such as WebSockets, where an application requests for the
--   server to grant it raw network access.
--   
--   This function requires a backup response to be provided, for the case
--   where the handler in question does not support such upgrading (e.g.,
--   CGI apps).
--   
--   In the event that you read from the request body before returning a
--   <tt>responseRaw</tt>, behavior is undefined.
--   
--   Since 2.1.0
responseRaw :: (IO ByteString -> (ByteString -> IO ()) -> IO ()) -> Response -> Response

-- | Accessing <a>Status</a> in <a>Response</a>.
responseStatus :: Response -> Status

-- | Accessing <a>ResponseHeaders</a> in <a>Response</a>.
responseHeaders :: Response -> ResponseHeaders

-- | Converting the body information in <a>Response</a> to a
--   <a>StreamingBody</a>.
responseToStream :: Response -> (Status, ResponseHeaders, (StreamingBody -> IO a) -> IO a)

-- | Apply the provided function to the response header list of the
--   Response.
mapResponseHeaders :: (ResponseHeaders -> ResponseHeaders) -> Response -> Response

-- | conditionally apply a <a>Middleware</a>
ifRequest :: (Request -> Bool) -> Middleware -> Middleware

-- | apply a function that modifies a response as a <a>Middleware</a>
modifyResponse :: (Response -> Response) -> Middleware
