@@ -10,8 +10,8 @@
1010--
1111module Streamly.Internal.Data.Serialize.TH
1212 ( deriveSerialize
13− , SerializeTHConfig(..)
14− , defaultSerializeTHConfig
13+ , Config(..)
14+ , defaultConfig
1515 , deriveSerializeWith
1616 ) where
1717
@@ -324,7 +324,7 @@ mkSerializeExpr tyOfTy =
324324-- Usage:
325325-- @
326326-- $(deriveSerializeInternal
327−-- defaultSerializeTHConfig
327+-- defaultConfig
328328-- [AppT (ConT ''Serialize) (VarT (mkName "b"))]
329329-- (AppT
330330-- (AppT (ConT ''CustomDataType) (VarT (mkName "a")))
@@ -339,8 +339,8 @@ mkSerializeExpr tyOfTy =
339339-- ])
340340-- @
341341deriveSerializeInternal ::
342− SerializeTHConfig -> Cxt -> Type -> [DataCon] -> Q [Dec]
343−deriveSerializeInternal (SerializeTHConfig{..}) preds headTy cons = do
342+ Config -> Cxt -> Type -> [DataCon] -> Q [Dec]
343+deriveSerializeInternal (Config{..}) preds headTy cons = do
344344 sizeOfMethod <- mkSizeOfExpr (typeOfType headTy cons)
345345 peekMethod <- mkDeserializeExpr headTy (typeOfType headTy cons)
346346 pokeMethod <- mkSerializeExpr (typeOfType headTy cons)
@@ -373,9 +373,9 @@ deriveSerializeInternal (SerializeTHConfig{..}) preds headTy cons = do
373373 return [plainInstanceD preds (AppT (ConT ''Serialize) headTy) methods]
374374
375375-- | Config to control how the 'Serialize' instance is generated.
376−data SerializeTHConfig =
377− SerializeTHConfig
378− { unconstrainedTypeVars :: [String]
376+data Config =
377+ Config
378+ { unconstrained :: [String]
379379 -- ^ Type variables that should not have the 'Serialize' constraint.
380380 --
381381 -- @
@@ -383,26 +383,26 @@ data SerializeTHConfig =
383383 -- @
384384 --
385385 -- @
386− -- conf = defaultConf {unconstrainedTypeVars = ["b", "d"]}
387− -- $(deriveSerializeWith conf ''CustomDataType)
386+ -- conf = defaultConf {unconstrained = ["b", "d"]}
387+ -- \$(deriveSerializeWith conf ''CustomDataType)
388388 -- @
389389 --
390390 -- @
391391 -- instance (Serialize a, Serialize c) => Serialize (CustomDataType a b c d) where
392392 -- ...
393393 -- @
394− , typeVarSubstitutions :: [(String, Type)]
395− -- ^ Substitute the type variable with the given type. All type
394+ , specializations :: [(String, Type)]
395+ -- ^ Specialize the type variable with the given type. All type
396396 -- variables listed here will not have the 'Serialize' constriant as
397− -- they are replaced.
397+ -- they are specialized.
398398 --
399399 -- @
400400 -- data CustomDataType f a = CustomDataType (f a)
401401 -- @
402402 --
403403 -- @
404− -- conf = defaultConf {typeVarSubstitutions = [("f", ''Identity)]}
405− -- $(deriveSerializeWith conf ''CustomDataType)
404+ -- conf = defaultConf {specializations = [("f", ''Identity)]}
405+ -- \$(deriveSerializeWith conf ''CustomDataType)
406406 -- @
407407 --
408408 -- @
@@ -418,20 +418,22 @@ data SerializeTHConfig =
418418 , inlineDeserialize :: Inline
419419 -- ^ Inline value for 'deserialize'. Default is Inline.
420420 , constructorTagAsString :: Bool
421− -- ^ If True, encode constructors as Latin-1 byte sequence. This
422− -- allows addition, removal, and reordering of constructors. If False
423− -- encode them as numbers. The default value is 'False'.
421+ -- ^ __Experimental__
422+ --
423+ -- If True, encode constructors using the constructor names as Latin-1
424+ -- byte sequence.
424425 , recordSyntaxWithHeader :: Bool
425− -- ^ If True, constructors with record syntax will be encoded in a
426− -- more compatible way. Allows addition, removal, and reordering of
427− -- fields. The default value is 'False'.
426+ -- ^ __Experimental__
427+ --
428+ -- If True, encode the keys of the record as a header and then
429+ -- serialize the data.
428430 }
429431
430−defaultSerializeTHConfig :: SerializeTHConfig
431−defaultSerializeTHConfig =
432− SerializeTHConfig
433− { unconstrainedTypeVars = []
434− , typeVarSubstitutions = []
432+defaultConfig :: Config
433+defaultConfig =
434+ Config
435+ { unconstrained = []
436+ , specializations = []
435437 , inlineSize = Inline
436438 , inlineSerialize = Inline
437439 , inlineDeserialize = Inline
@@ -439,12 +441,12 @@ defaultSerializeTHConfig =
439441 , recordSyntaxWithHeader = False
440442 }
441443
442−-- | Similar to 'deriveSerialize,' but take a 'SerializeTHConfig' to control how
444+-- | Similar to 'deriveSerialize,' but take a 'Config' to control how
443445-- the instance is generated.
444446--
445447-- Usage: @$(deriveSerializeWith config ''CustomDataType)@
446−deriveSerializeWith :: SerializeTHConfig -> Name -> Q [Dec]
447−deriveSerializeWith conf@(SerializeTHConfig {..}) name = do
448+deriveSerializeWith :: Config -> Name -> Q [Dec]
449+deriveSerializeWith conf@(Config {..}) name = do
448450 dt <- reifyDataType name
449451 let preds = map (unboxPred . VarT) (filterOutVars (dtTvs dt))
450452 headTy = appsT (ConT name) (map substituteVar (dtTvs dt))
@@ -453,13 +455,13 @@ deriveSerializeWith conf@(SerializeTHConfig {..}) name = do
453455
454456 where
455457 allUnconstrainedTypeVars =
456− unconstrainedTypeVars ++ map fst typeVarSubstitutions
458+ unconstrained ++ map fst specializations
457459 filterOutVars vs =
458460 map mkName
459461 $ filter (not . flip elem allUnconstrainedTypeVars)
460462 $ map nameBase vs
461463 substituteVar v =
462− case lookup (nameBase v) typeVarSubstitutions of
464+ case lookup (nameBase v) specializations of
463465 Nothing -> VarT v
464466 Just ty -> ty
465467
@@ -489,6 +491,7 @@ deriveSerializeWith conf@(SerializeTHConfig {..}) name = do
489491-- To control which type variables don't get the Serialize constraint, use
490492-- 'deriveSerializeWith'.
491493--
492−-- >>> deriveSerialize = deriveSerializeWith 'defaultSerializeTHConfig'
494+-- >>> import qualified Streamly.Internal.Data.Serialize.TH as Serialize
495+-- >>> deriveSerialize = Serialize.deriveSerializeWith Serialize.defaultConfig
493496deriveSerialize :: Name -> Q [Dec]
494−deriveSerialize name = deriveSerializeWith defaultSerializeTHConfig name
497+deriveSerialize name = deriveSerializeWith defaultConfig name