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


-- | Generic HTTP types for Haskell (for both client and server code).
--   
--   Generic HTTP types for Haskell (for both client and server code).
@package http-types
@version 0.6.3

module Network.HTTP.Types
type Ascii = ByteString

-- | HTTP method (flat string type).
type Method = Ascii
methodGet :: Method

-- | HTTP Method constants.
methodPost :: Method
methodHead :: Method
methodPut :: Method
methodDelete :: Method
methodTrace :: Method
methodConnect :: Method
methodOptions :: Method

-- | HTTP standard method (as defined by RFC 2616).
data StdMethod
GET :: StdMethod
POST :: StdMethod
HEAD :: StdMethod
PUT :: StdMethod
DELETE :: StdMethod
TRACE :: StdMethod
CONNECT :: StdMethod
OPTIONS :: StdMethod

-- | Convert a method <tt>ByteString</tt> to a <a>StdMethod</a> if
--   possible.
parseMethod :: Method -> Either Ascii StdMethod

-- | Convert an algebraic method to a <tt>ByteString</tt>.
renderMethod :: Either Ascii StdMethod -> Method

-- | Convert a <a>StdMethod</a> to a <tt>ByteString</tt>.
renderStdMethod :: StdMethod -> Method

-- | HTTP Version.
--   
--   Note that the Show instance is intended merely for debugging.
data HttpVersion
HttpVersion :: !Int -> !Int -> HttpVersion
httpMajor :: HttpVersion -> !Int
httpMinor :: HttpVersion -> !Int

-- | HTTP 0.9
http09 :: HttpVersion

-- | HTTP 1.0
http10 :: HttpVersion

-- | HTTP 1.1
http11 :: HttpVersion

-- | HTTP Status.
--   
--   Only the <a>statusCode</a> is used for comparisons.
--   
--   Note that the Show instance is only for debugging.
data Status
Status :: Int -> Ascii -> Status
statusCode :: Status -> Int
statusMessage :: Status -> Ascii
status200 :: Status

-- | OK
statusOK :: Status
status201 :: Status

-- | Created
statusCreated :: Status
status206 :: Status

-- | PartialContent
statusPartialContent :: Status
status301 :: Status

-- | Moved Permanently
statusMovedPermanently :: Status
status302 :: Status

-- | Found
statusFound :: Status
status303 :: Status

-- | See Other
statusSeeOther :: Status
status304 :: Status

-- | Not Modified
statusNotModified :: Status
status400 :: Status

-- | Bad Request
statusBadRequest :: Status
status401 :: Status

-- | Unauthorized
statusUnauthorized :: Status
status403 :: Status

-- | Forbidden
statusForbidden :: Status
status404 :: Status

-- | Not Found
statusNotFound :: Status
status405 :: Status

-- | Method Not Allowed
statusNotAllowed :: Status
status412 :: Status

-- | Precondition Failed
statusPreconditionFailed :: Status
status416 :: Status

-- | Requested Range Not Satisfiable
statusRequestedRangeNotSatisfiable :: Status
status500 :: Status

-- | Internal Server Error
statusServerError :: Status
status501 :: Status

-- | Not Implemented
statusNotImplemented :: Status

-- | Header
type Header = (CI Ascii, Ascii)

-- | Request Headers
type RequestHeaders = [Header]

-- | Response Headers
type ResponseHeaders = [Header]
headerAccept :: Ascii -> Header

-- | HTTP Headers
headerAuthorization :: Ascii -> Header
headerCacheControl :: Ascii -> Header
headerConnection :: Ascii -> Header
headerContentLength :: Ascii -> Header
headerContentType :: Ascii -> Header
headerContentMD5 :: Ascii -> Header
headerDate :: Ascii -> Header

-- | Query item
type QueryItem = (ByteString, Maybe ByteString)

-- | Query.
--   
--   General form: a=b&amp;c=d, but if the value is Nothing, it becomes
--   a&amp;c=d.
type Query = [QueryItem]

-- | Simplified Query item type without support for parameter-less items.
type SimpleQueryItem = (ByteString, ByteString)

-- | Simplified Query type without support for parameter-less items.
type SimpleQuery = [SimpleQueryItem]

-- | Convert <a>SimpleQuery</a> to <a>Query</a>.
simpleQueryToQuery :: SimpleQuery -> Query

-- | Convert <a>Query</a> to <tt>ByteString</tt>.
renderQuery :: Bool -> Query -> Ascii
renderQueryBuilder :: Bool -> Query -> Builder

-- | Convert <a>SimpleQuery</a> to <tt>ByteString</tt>.
renderSimpleQuery :: Bool -> SimpleQuery -> Ascii

-- | Split out the query string into a list of keys and values. A few
--   importants points:
--   
--   <ul>
--   <li>The result returned is still bytestrings, since we perform no
--   character decoding here. Most likely, you will want to use UTF-8
--   decoding, but this is left to the user of the library.</li>
--   <li>Percent decoding errors are ignored. In particular, <a>%Q</a> will
--   be output as <a>%Q</a>.</li>
--   </ul>
parseQuery :: ByteString -> Query

-- | Parse <a>SimpleQuery</a> from a <tt>ByteString</tt>.
parseSimpleQuery :: ByteString -> SimpleQuery
type QueryText = [(Text, Maybe Text)]
queryTextToQuery :: QueryText -> Query
queryToQueryText :: Query -> QueryText
renderQueryText :: Bool -> QueryText -> Builder
parseQueryText :: ByteString -> QueryText

-- | Encodes a list of path segments into a valid URL fragment.
--   
--   This function takes the following three steps:
--   
--   <ul>
--   <li>UTF-8 encodes the characters.</li>
--   <li>Performs percent encoding on all unreserved characters, as well as
--   :@=+$,</li>
--   <li>Intercalates with a slash.</li>
--   </ul>
--   
--   For example:
--   
--   <pre>
--   encodePathInfo [\"foo\", \"bar\", \"baz\"]
--   </pre>
--   
--   "foo/bar/baz"
--   
--   <pre>
--   encodePathInfo [\"foo bar\", \"baz\/bin\"]
--   </pre>
--   
--   "foo%20bar/baz%2Fbin"
--   
--   <pre>
--   encodePathInfo [\"\"]
--   </pre>
--   
--   "%D7%A9%D7%9C%D7%95%D7%9D"
--   
--   Huge thanks to Jeremy Shaw who created the original implementation of
--   this function in web-routes and did such thorough research to
--   determine all correct escaping procedures.
encodePathSegments :: [Text] -> Builder
decodePathSegments :: ByteString -> [Text]
encodePath :: [Text] -> Query -> Builder
decodePath :: ByteString -> ([Text], Query)
urlEncodeBuilder :: Bool -> ByteString -> Builder
urlEncode :: Bool -> ByteString -> Ascii

-- | Percent-decoding.
urlDecode :: Bool -> ByteString -> ByteString
instance Read StdMethod
instance Show StdMethod
instance Eq StdMethod
instance Ord StdMethod
instance Enum StdMethod
instance Bounded StdMethod
instance Ix StdMethod
instance Eq HttpVersion
instance Ord HttpVersion
instance Show Status
instance Ord Status
instance Eq Status
instance Show HttpVersion