git.iko.soy/typeable/http-api-data
on 6454ed0 help sign in
typeable/http-api-data/src/Web/HttpApiData.hs
93 lines 1.9 kB history raw
1-- |
2-- Convert Haskell values to and from HTTP API data
3-- such as URL pieces, headers and query parameters.
4module Web.HttpApiData (
5 -- * Examples
6 -- $examples
8 -- * Classes
9 ToHttpApiData (..),
10 FromHttpApiData (..),
12 -- * @'Maybe'@ parsers
13 parseUrlPieceMaybe,
14 parseHeaderMaybe,
15 parseQueryParamMaybe,
17 -- * Prefix parsers
18 parseUrlPieceWithPrefix,
19 parseHeaderWithPrefix,
20 parseQueryParamWithPrefix,
22 -- * Multiple URL pieces
23 toUrlPieces,
24 parseUrlPieces,
26 -- * Multiple query params
27 toQueryParams,
28 parseQueryParams,
30 -- * Parsers for @'Bounded'@ @'Enum'@s
31 parseBoundedUrlPiece,
32 parseBoundedQueryParam,
33 parseBoundedHeader,
34 parseBoundedEnumOf,
35 parseBoundedEnumOfI,
36 parseBoundedTextData,
38 -- * Lenient data
39 LenientData (..),
41 -- * Other helpers
42 showTextData,
43 readTextData,
44) where
46import Web.Internal.HttpApiData
48-- $setup
49--
50-- >>> :set -XOverloadedStrings
51-- >>> import Control.Applicative
52-- >>> import Data.Time
53-- >>> import Data.Int
54-- >>> import Data.Text (Text)
55-- >>> import Data.Time (Day)
56-- >>> import Data.Version
58-- $examples
59--
60-- Booleans:
61--
62-- >>> toUrlPiece True
63-- "true"
64-- >>> parseUrlPiece "false" :: Either Text Bool
65-- Right False
66-- >>> parseUrlPieces ["true", "false", "undefined"] :: Either Text [Bool]
67-- Left "could not parse: `undefined'"
68--
69-- Numbers:
70--
71-- >>> toQueryParam 45.2
72-- "45.2"
73-- >>> parseQueryParam "452" :: Either Text Int
74-- Right 452
75-- >>> toQueryParams [1..5] :: [Text]
76-- ["1","2","3","4","5"]
77-- >>> parseQueryParams ["127", "255"] :: Either Text [Int8]
78-- Left "out of bounds: `255' (should be between -128 and 127)"
79--
80-- Strings:
81--
82-- >>> toHeader "hello"
83-- "hello"
84-- >>> parseHeader "world" :: Either Text String
85-- Right "world"
86--
87-- Calendar day:
88--
89-- >>> toQueryParam (fromGregorian 2015 10 03)
90-- "2015-10-03"
91-- >>> toGregorian <$> parseQueryParam "2016-12-01"
92-- Right (2016,12,1)