Safe Haskell	None
Language	Haskell2010

VtUtils.HTTP

Description

HTTP utilities for server (WAI) and client

Synopsis

httpContentTypeJSON :: Header
httpRequestPath :: Request -> Text
httpRequestBodyText :: Request -> IO Text
data HTTPRequestBodyJSONException = HTTPRequestBodyJSONException {
- requestBody :: ByteString
- message :: Text
}
httpRequestBodyJSON :: forall a. FromJSON a => Request -> IO a
httpRequestHeaders :: Request -> Vector (Text, Text)
httpRequestHeadersMap :: Request -> HashMap Text Text
data HTTPResponseBodyException = HTTPResponseBodyException {
- threshold :: Int
- read :: Int
- label :: Text
- responsePart :: ByteString
}
httpResponseBody :: Text -> Response BodyReader -> Int -> IO ByteString
httpResponseBodyText :: Text -> Response BodyReader -> Int -> IO Text
data HTTPResponseBodyJSONException = HTTPResponseBodyJSONException {
- response :: ByteString
- label :: Text
- message :: Text
}
httpResponseBodyJSON :: forall a. FromJSON a => Text -> Response BodyReader -> Int -> IO a
httpResponseHeaders :: Response a -> Vector (Text, Text)
httpResponseHeadersMap :: Response a -> HashMap Text Text

Documentation

httpContentTypeJSON :: Header Source #

Content-Type header for application/json type

httpRequestPath :: Request -> Text Source #

URL path string of the specified HTTP request

Arguments:

req :: Request: HTTP request

Return value: URL path string

httpRequestBodyText :: Request -> IO Text Source #

Reads a body of the specified HTTP request as a Text string

Arguments:

req :: Request: HTTP request

Return value: Request body as a Text string

data HTTPRequestBodyJSONException Source #

Exception for httpRequestBodyJSON function

Constructors

HTTPRequestBodyJSONException
Fields requestBody :: ByteString Request body containing invalid JSON message :: Text JSON parsing error message

Instances

Show HTTPRequestBodyJSONException Source #
Instance details Defined in VtUtils.HTTP Methods showsPrec :: Int -> HTTPRequestBodyJSONException -> ShowS # show :: HTTPRequestBodyJSONException -> String # showList :: [HTTPRequestBodyJSONException] -> ShowS #
Exception HTTPRequestBodyJSONException Source #
Instance details Defined in VtUtils.HTTP Methods toException :: HTTPRequestBodyJSONException -> SomeException # fromException :: SomeException -> Maybe HTTPRequestBodyJSONException # displayException :: HTTPRequestBodyJSONException -> String #

httpRequestBodyJSON :: forall a. FromJSON a => Request -> IO a Source #

Reads a body of the specified HTTP request and parses it as a JSON value

Data type should be specified with a type annotation:

Example:

dt <- httpRequestBodyJSON req :: IO Foo

Data must be an instance of FromJSON

Throws an exception if request body doesn't contain valid JSON.

Arguments:

req :: Request: HTTP request

Return value: Request body parsed as a JSON value

httpRequestHeaders :: Request -> Vector (Text, Text) Source #

Headers of the specified HTTP request as a Vector of (name, value) pairs

Arguments:

req :: Request: HTTP request

Return value: Request headers as a Vector of (name, value) pairs

httpRequestHeadersMap :: Request -> HashMap Text Text Source #

Headers of the specified HTTP request as a name -> value map

Arguments:

req :: Request: HTTP request

Return value: Request headers as a name -> value map

data HTTPResponseBodyException Source #

Exception for httpRequestBodyJSON function

Constructors

HTTPResponseBodyException
Fields threshold :: Int Max allowed bytes to read read :: Int Bytes actually read label :: Text Caller-supplied label responsePart :: ByteString Part of the response that was read

Instances

Show HTTPResponseBodyException Source #
Instance details Defined in VtUtils.HTTP Methods showsPrec :: Int -> HTTPResponseBodyException -> ShowS # show :: HTTPResponseBodyException -> String # showList :: [HTTPResponseBodyException] -> ShowS #
Exception HTTPResponseBodyException Source #
Instance details Defined in VtUtils.HTTP Methods toException :: HTTPResponseBodyException -> SomeException # fromException :: SomeException -> Maybe HTTPResponseBodyException # displayException :: HTTPResponseBodyException -> String #

httpResponseBody :: Text -> Response BodyReader -> Int -> IO ByteString Source #

Read a body of HTTP response as a lazy ByteString

Throws an exception if specified threshold is exceeded.

Arguments:

label :: Text: Label used for error reporting on overly-large responses
resp :: Response BodyReader: HTTP response
threshold :: Int Max response body length in bytes

Return value: Response body as a lazy ByteString

httpResponseBodyText :: Text -> Response BodyReader -> Int -> IO Text Source #

Read a body of HTTP response as a Text string

Arguments:

label :: Text: Label used for error reporting on overly-large responses
resp :: Response BodyReader: HTTP response
threshold :: Int Max response body length in bytes

Return value: Response body as a Text string

data HTTPResponseBodyJSONException Source #

Exception for httpResponseBodyJSON function

Constructors

HTTPResponseBodyJSONException
Fields response :: ByteString Response body containing invalid JSON label :: Text Caller-supplied label message :: Text JSON parsing error message

Instances

Show HTTPResponseBodyJSONException Source #
Instance details Defined in VtUtils.HTTP Methods showsPrec :: Int -> HTTPResponseBodyJSONException -> ShowS # show :: HTTPResponseBodyJSONException -> String # showList :: [HTTPResponseBodyJSONException] -> ShowS #
Exception HTTPResponseBodyJSONException Source #
Instance details Defined in VtUtils.HTTP Methods toException :: HTTPResponseBodyJSONException -> SomeException # fromException :: SomeException -> Maybe HTTPResponseBodyJSONException # displayException :: HTTPResponseBodyJSONException -> String #

httpResponseBodyJSON :: forall a. FromJSON a => Text -> Response BodyReader -> Int -> IO a Source #

Read a body of HTTP response as a JSON value

Data type should be specified with a type annotation:

Example:

dt <- httpResponseBodyJSON label resp 1024 :: IO Foo

Data must be an instance of FromJSON

Throws an exception if response body doesn't contain valid JSON.

Arguments:

label :: Text: Label used for error reporting on overly-large responses
resp :: Response BodyReader: HTTP response
threshold :: Int Max response body length in bytes

Return value: Response body as a JSON value

httpResponseHeaders :: Response a -> Vector (Text, Text) Source #

Headers of the specified HTTP response as a Vector of (name, value) pairs

Arguments:

req :: Response: HTTP request

Return value: Response headers as a Vector of (name, value) pairs

httpResponseHeadersMap :: Response a -> HashMap Text Text Source #

Headers of the specified HTTP response as a name -> value map

Arguments:

req :: Response: HTTP request

Return value: Response headers as a name -> value map