@@ -73,7 +73,9 @@ class ToHttpApiData a where
7373 toUrlPiece :: a -> Text
7474 toUrlPiece = toQueryParam
7575
76− -- | Convert to a URL path piece, making sure to encode any special chars
76+ -- | Convert to a URL path piece, making sure to encode any special chars.
77+ -- The default definition uses 'H.encodePathSegmentsRelative',
78+ -- but this may be overriden with a more efficient version.
7779 toEncodedUrlPiece :: a -> BS.Builder
7880 toEncodedUrlPiece = H.encodePathSegmentsRelative . (:[]) . toUrlPiece
7981
@@ -394,46 +396,58 @@ parseBounded reader input = do
394396 l = toInteger (minBound :: a)
395397 h = toInteger (maxBound :: a)
396398
399+-- | Convert to a URL-encoded path piece using 'toUrlPiece'.
400+-- /Note/: this function does not check if the result contains unescaped characters!
401+-- This function can be used to override 'toEncodedUrlPiece' as a more efficient implementation
402+-- when the resulting URL piece /never/ has to be escaped.
403+unsafeToEncodedUrlPiece :: ToHttpApiData a => a -> BS.Builder
404+unsafeToEncodedUrlPiece = BS.byteString . encodeUtf8 . toUrlPiece
405+
397406-- |
398407-- >>> toUrlPiece ()
399408-- "_"
400409instance ToHttpApiData () where
401410 toUrlPiece () = "_"
411+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
402412
403−instance ToHttpApiData Char where toUrlPiece = T.singleton
413+instance ToHttpApiData Char where
414+ toUrlPiece = T.singleton
404415
405416-- |
406417-- >>> toUrlPiece (Version [1, 2, 3] [])
407418-- "1.2.3"
408419instance ToHttpApiData Version where
409420 toUrlPiece = T.pack . showVersion
421+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
410422
411423#if MIN_VERSION_base(4,8,0)
412424instance ToHttpApiData Void where toUrlPiece = absurd
413−instance ToHttpApiData Natural where toUrlPiece = showt
425+instance ToHttpApiData Natural where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
414426#endif
415427
416−instance ToHttpApiData Bool where toUrlPiece = showTextData
417−instance ToHttpApiData Ordering where toUrlPiece = showTextData
418−
419−instance ToHttpApiData Double where toUrlPiece = showt
420−instance ToHttpApiData Float where toUrlPiece = showt
421−instance ToHttpApiData Int where toUrlPiece = showt
422−instance ToHttpApiData Int8 where toUrlPiece = showt
423−instance ToHttpApiData Int16 where toUrlPiece = showt
424−instance ToHttpApiData Int32 where toUrlPiece = showt
425−instance ToHttpApiData Int64 where toUrlPiece = showt
426−instance ToHttpApiData Integer where toUrlPiece = showt
427−instance ToHttpApiData Word where toUrlPiece = showt
428−instance ToHttpApiData Word8 where toUrlPiece = showt
429−instance ToHttpApiData Word16 where toUrlPiece = showt
430−instance ToHttpApiData Word32 where toUrlPiece = showt
431−instance ToHttpApiData Word64 where toUrlPiece = showt
428+instance ToHttpApiData Bool where toUrlPiece = showTextData; toEncodedUrlPiece = unsafeToEncodedUrlPiece
429+instance ToHttpApiData Ordering where toUrlPiece = showTextData; toEncodedUrlPiece = unsafeToEncodedUrlPiece
430+
431+instance ToHttpApiData Double where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
432+instance ToHttpApiData Float where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
433+instance ToHttpApiData Int where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
434+instance ToHttpApiData Int8 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
435+instance ToHttpApiData Int16 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
436+instance ToHttpApiData Int32 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
437+instance ToHttpApiData Int64 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
438+instance ToHttpApiData Integer where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
439+instance ToHttpApiData Word where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
440+instance ToHttpApiData Word8 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
441+instance ToHttpApiData Word16 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
442+instance ToHttpApiData Word32 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
443+instance ToHttpApiData Word64 where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
432444
433445-- |
434446-- >>> toUrlPiece (fromGregorian 2015 10 03)
435447-- "2015-10-03"
436−instance ToHttpApiData Day where toUrlPiece = T.pack . show
448+instance ToHttpApiData Day where
449+ toUrlPiece = T.pack . show
450+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
437451
438452timeToUrlPiece :: FormatTime t => String -> t -> Text
439453timeToUrlPiece fmt = T.pack . formatTime defaultTimeLocale (iso8601DateFormat (Just fmt))
@@ -441,32 +455,54 @@ timeToUrlPiece fmt = T.pack . formatTime defaultTimeLocale (iso8601DateFormat (J
441455-- |
442456-- >>> toUrlPiece $ LocalTime (fromGregorian 2015 10 03) (TimeOfDay 14 55 01)
443457-- "2015-10-03T14:55:01"
444−instance ToHttpApiData LocalTime where toUrlPiece = timeToUrlPiece "%H:%M:%S"
458+instance ToHttpApiData LocalTime where
459+ toUrlPiece = timeToUrlPiece "%H:%M:%S"
460+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
445461
446462-- |
447463-- >>> toUrlPiece $ ZonedTime (LocalTime (fromGregorian 2015 10 03) (TimeOfDay 14 55 01)) utc
448464-- "2015-10-03T14:55:01+0000"
449−instance ToHttpApiData ZonedTime where toUrlPiece = timeToUrlPiece "%H:%M:%S%z"
465+instance ToHttpApiData ZonedTime where
466+ toUrlPiece = timeToUrlPiece "%H:%M:%S%z"
467+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
450468
451469-- |
452470-- >>> toUrlPiece $ UTCTime (fromGregorian 2015 10 03) 864
453471-- "2015-10-03T00:14:24Z"
454−instance ToHttpApiData UTCTime where toUrlPiece = timeToUrlPiece "%H:%M:%SZ"
472+instance ToHttpApiData UTCTime where
473+ toUrlPiece = timeToUrlPiece "%H:%M:%SZ"
474+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
455475
456−instance ToHttpApiData NominalDiffTime where toUrlPiece = toUrlPiece . (floor :: NominalDiffTime -> Integer)
476+instance ToHttpApiData NominalDiffTime where
477+ toUrlPiece = toUrlPiece . (floor :: NominalDiffTime -> Integer)
478+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
457479
458480instance ToHttpApiData String where toUrlPiece = T.pack
459481instance ToHttpApiData Text where toUrlPiece = id
460482instance ToHttpApiData L.Text where toUrlPiece = L.toStrict
461483
462−instance ToHttpApiData All where toUrlPiece = toUrlPiece . getAll
463−instance ToHttpApiData Any where toUrlPiece = toUrlPiece . getAny
484+instance ToHttpApiData All where toUrlPiece = toUrlPiece . getAll; toEncodedUrlPiece = toEncodedUrlPiece . getAll
485+instance ToHttpApiData Any where toUrlPiece = toUrlPiece . getAny; toEncodedUrlPiece = toEncodedUrlPiece . getAny
486+
487+instance ToHttpApiData a => ToHttpApiData (Dual a) where
488+ toUrlPiece = toUrlPiece . getDual
489+ toEncodedUrlPiece = toEncodedUrlPiece . getDual
490+
491+instance ToHttpApiData a => ToHttpApiData (Sum a) where
492+ toUrlPiece = toUrlPiece . getSum
493+ toEncodedUrlPiece = toEncodedUrlPiece . getSum
494+
495+instance ToHttpApiData a => ToHttpApiData (Product a) where
496+ toUrlPiece = toUrlPiece . getProduct
497+ toEncodedUrlPiece = toEncodedUrlPiece . getProduct
498+
499+instance ToHttpApiData a => ToHttpApiData (First a) where
500+ toUrlPiece = toUrlPiece . getFirst
501+ toEncodedUrlPiece = toEncodedUrlPiece . getFirst
464502
465−instance ToHttpApiData a => ToHttpApiData (Dual a) where toUrlPiece = toUrlPiece . getDual
466−instance ToHttpApiData a => ToHttpApiData (Sum a) where toUrlPiece = toUrlPiece . getSum
467−instance ToHttpApiData a => ToHttpApiData (Product a) where toUrlPiece = toUrlPiece . getProduct
468−instance ToHttpApiData a => ToHttpApiData (First a) where toUrlPiece = toUrlPiece . getFirst
469−instance ToHttpApiData a => ToHttpApiData (Last a) where toUrlPiece = toUrlPiece . getLast
503+instance ToHttpApiData a => ToHttpApiData (Last a) where
504+ toUrlPiece = toUrlPiece . getLast
505+ toEncodedUrlPiece = toEncodedUrlPiece . getLast
470506
471507-- |
472508-- >>> toUrlPiece (Just "Hello")
@@ -597,6 +633,7 @@ instance (FromHttpApiData a, FromHttpApiData b) => FromHttpApiData (Either a b)
597633instance ToHttpApiData UUID.UUID where
598634 toUrlPiece = UUID.toText
599635 toHeader = UUID.toASCIIBytes
636+ toEncodedUrlPiece = unsafeToEncodedUrlPiece
600637
601638instance FromHttpApiData UUID.UUID where
602639 parseUrlPiece = maybe (Left "invalid UUID") Right . UUID.fromText