Safe Haskell	Safe
Language	Haskell98

Web.HttpApiData.Internal

Description

Convert Haskell values to and from HTTP API data such as URL pieces, headers and query parameters.

Synopsis

Documentation

class ToHttpApiData a where Source

Convert value to HTTP API data.

Minimal complete definition

toUrlPiece | toQueryParam

Methods

toUrlPiece :: a -> Text Source

Convert to URL path piece.

toHeader :: a -> ByteString Source

Convert to HTTP header value.

toQueryParam :: a -> Text Source

Convert to query param value.

Instances

ToHttpApiData Bool Source
ToHttpApiData Char Source
ToHttpApiData Double Source
ToHttpApiData Float Source
ToHttpApiData Int Source
ToHttpApiData Int8 Source
ToHttpApiData Int16 Source
ToHttpApiData Int32 Source
ToHttpApiData Int64 Source
ToHttpApiData Integer Source
ToHttpApiData Ordering Source
ToHttpApiData Word Source
ToHttpApiData Word8 Source
ToHttpApiData Word16 Source
ToHttpApiData Word32 Source
ToHttpApiData Word64 Source
ToHttpApiData String Source
ToHttpApiData () Source	`>>>` `toUrlPiece ()`"_"
ToHttpApiData Void Source
ToHttpApiData Version Source	`>>>` `toUrlPiece (Version [1, 2, 3] [])`"1.2.3"
ToHttpApiData All Source
ToHttpApiData Any Source
ToHttpApiData Text Source
ToHttpApiData Text Source
ToHttpApiData Day Source
ToHttpApiData a => ToHttpApiData (Dual a) Source
ToHttpApiData a => ToHttpApiData (Sum a) Source
ToHttpApiData a => ToHttpApiData (Product a) Source
ToHttpApiData a => ToHttpApiData (First a) Source
ToHttpApiData a => ToHttpApiData (Last a) Source
ToHttpApiData a => ToHttpApiData (Maybe a) Source	`>>>` `toUrlPiece (Just "Hello")`"just Hello"
(ToHttpApiData a, ToHttpApiData b) => ToHttpApiData (Either a b) Source	`>>>` `toUrlPiece (Left "err" :: Either String Int)`"left err" `>>>` `toUrlPiece (Right 3 :: Either String Int)`"right 3"

class FromHttpApiData a where Source

Parse value from HTTP API data.

Minimal complete definition

parseUrlPiece | parseQueryParam

Methods

parseUrlPiece :: Text -> Either Text a Source

Parse URL path piece.

parseHeader :: ByteString -> Either Text a Source

Parse HTTP header value.

parseQueryParam :: Text -> Either Text a Source

Parse query param value.

Instances

FromHttpApiData Bool Source
FromHttpApiData Char Source
FromHttpApiData Double Source
FromHttpApiData Float Source
FromHttpApiData Int Source
FromHttpApiData Int8 Source
FromHttpApiData Int16 Source
FromHttpApiData Int32 Source
FromHttpApiData Int64 Source
FromHttpApiData Integer Source
FromHttpApiData Ordering Source
FromHttpApiData Word Source
FromHttpApiData Word8 Source
FromHttpApiData Word16 Source
FromHttpApiData Word32 Source
FromHttpApiData Word64 Source
FromHttpApiData String Source
FromHttpApiData () Source	`>>>` `parseUrlPiece "_" :: Either Text ()`Right ()
FromHttpApiData Void Source
FromHttpApiData Version Source	`>>>` `showVersion <$> parseUrlPiece "1.2.3"`Right "1.2.3"
FromHttpApiData All Source
FromHttpApiData Any Source
FromHttpApiData Text Source
FromHttpApiData Text Source
FromHttpApiData Day Source
FromHttpApiData a => FromHttpApiData (Dual a) Source
FromHttpApiData a => FromHttpApiData (Sum a) Source
FromHttpApiData a => FromHttpApiData (Product a) Source
FromHttpApiData a => FromHttpApiData (First a) Source
FromHttpApiData a => FromHttpApiData (Last a) Source
FromHttpApiData a => FromHttpApiData (Maybe a) Source	`>>>` `parseUrlPiece "Just 123" :: Either Text (Maybe Int)`Right (Just 123)
(FromHttpApiData a, FromHttpApiData b) => FromHttpApiData (Either a b) Source	`>>>` `parseUrlPiece "Right 123" :: Either Text (Either String Int)`Right (Right 123)

parseUrlPieceMaybe :: FromHttpApiData a => Text -> Maybe a Source

Parse URL path piece in a Maybe.

>>> parseUrlPieceMaybe "12" :: Maybe Int
Just 12

parseHeaderMaybe :: FromHttpApiData a => ByteString -> Maybe a Source

Parse HTTP header value in a Maybe.

>>> parseHeaderMaybe "hello" :: Maybe Text
Just "hello"

parseQueryParamMaybe :: FromHttpApiData a => Text -> Maybe a Source

Parse query param value in a Maybe.

>>> parseQueryParamMaybe "true" :: Maybe Bool
Just True

defaultParseError :: Text -> Either Text a Source

Default parsing error.

parseMaybeTextData :: (Text -> Maybe a) -> Text -> Either Text a Source

Convert Maybe parser into Either Text parser with default error message.

showTextData :: Show a => a -> Text Source

Convert to URL piece using Show instance. The result is always lower cased.

>>> showTextData True
"true"

This can be used as a default implementation for enumeration types:

>>> data MyData = Foo | Bar | Baz deriving (Show)
>>> instance ToHttpApiData MyData where toUrlPiece = showTextData
>>> toUrlPiece Foo
"foo"

parseUrlPieceWithPrefix :: FromHttpApiData a => Text -> Text -> Either Text a Source

Parse given text case insensitive and return the rest of the input.

>>> parseUrlPieceWithPrefix "Just " "just 10" :: Either Text Int
Right 10
>>> parseUrlPieceWithPrefix "Left " "left" :: Either Text Bool
Left "could not parse: `left'"

This can be used to implement FromHttpApiData for single field constructors:

>>> data Foo = Foo Int deriving (Show)
>>> instance FromHttpApiData Foo where parseUrlPiece s = Foo <$> parseUrlPieceWithPrefix "Foo " s
>>> parseUrlPiece "foo 1" :: Either Text Foo
Right (Foo 1)

parseBoundedCaseInsensitiveTextData :: forall a. (Show a, Bounded a, Enum a) => Text -> Either Text a Source

Parse values case insensitively based on Show instance.

>>> parseBoundedCaseInsensitiveTextData "true" :: Either Text Bool
Right True
>>> parseBoundedCaseInsensitiveTextData "FALSE" :: Either Text Bool
Right False

This can be used as a default implementation for enumeration types:

>>> data MyData = Foo | Bar | Baz deriving (Show, Bounded, Enum)
>>> instance FromHttpApiData MyData where parseUrlPiece = parseBoundedCaseInsensitiveTextData
>>> parseUrlPiece "foo" :: Either Text MyData
Right Foo

readMaybeTextData :: Read a => Text -> Maybe a Source

Parse URL piece using Read instance.

readEitherTextData :: Read a => Text -> Either Text a Source

Parse URL piece using Read instance.

runReader :: Reader a -> Text -> Either Text a Source

Run Reader as HTTP API data parser.

parseBounded :: forall a. (Bounded a, Integral a) => Reader Integer -> Text -> Either Text a Source

Run Reader to parse bounded integral value with bounds checking.

>>> parseBounded decimal "256" :: Either Text Word8
Left "out of bounds: `256' (should be between 0 and 255)"