typed-encoding 0.5.2.0 → 0.5.2.1
raw patch · 5 files changed
+19/−7 lines, 5 files
Files
- ChangeLog.md +4/−0
- README.md +1/−2
- src/Data/TypedEncoding.hs +10/−3
- src/Examples/TypedEncoding/Conversions.hs +2/−0
- typed-encoding.cabal +2/−2
ChangeLog.md view
@@ -5,6 +5,10 @@ - `Data.TypedEncoding.Common.Class.IsStringR` expected to be be changed / replaced - (post 0.5) "enc-B64" could be moved to a different package (more distant goal) ++## 0.5.2.1++- documentation improvements ## 0.5.2.0 - Fixed up IsSuperset type family improving transitivity
README.md view
@@ -59,7 +59,7 @@ phone = ... ``` -The author often uses _typed_encoding_ with _Servant_ (`HttpApiData` instances are not included), e.g.:+The author often uses _typed-encoding_ with _Servant_ (`HttpApiData` instances are not included), e.g.: ```Haskell type LookupByPhone = @@ -85,7 +85,6 @@ ## Examples Please see `Examples.TypedEncoding` it the module list.- ## Other encoding packages
src/Data/TypedEncoding.hs view
@@ -38,7 +38,7 @@ -- * /encoding/ -- * /decoding/ -- * /validation (recreation)/ (verification of existing payload)--- * type conversions between encoded types+-- * safe type conversions between encoded types -- * combinators for creating new encodings from existing encodings (e.g. by applying Boolean rules) -- -- of string-like data (@ByteString@, @Text@) that is subject of some@@ -96,8 +96,15 @@ -- -- ... and needed conversions. ----- Conversion combinator module structure is similar to one found in /text/ and /bytestring/ packages--- Please see comments in "Data.TypedEncoding.Conv" for more information.+-- Conversion combinator module structure is similar to the one found in /text/ and /bytestring/ packages.+--+-- Conversion is /typed-encoding/ are safe and reversible!+--+-- Please see comments in +-- +-- * "Data.TypedEncoding.Conv" +--+-- for more information. -- -- The instance list is not intended to be exhaustive, rather separate libraries -- can provide instances for other encodings and transformations.
src/Examples/TypedEncoding/Conversions.hs view
@@ -10,6 +10,8 @@ -- | Examples or moving between type annotated encodings --+-- Please also see documentation in "Data.TypedEncoding.Conv".+-- -- Haskell programs typically make these imports to do String, ByteString, and Text conversions: -- -- @
typed-encoding.cabal view
@@ -4,10 +4,10 @@ -- -- see: https://github.com/sol/hpack ----- hash: 085d089a3961a826a165b1612c576bd1bda3176093afa389e3f7e082ac26caeb+-- hash: 08175a1ab64ba86ea1a414806e2b66063f5fa0c3659e8335a376682440107c09 name: typed-encoding-version: 0.5.2.0+version: 0.5.2.1 synopsis: Type safe string transformations description: See README.md in the project github repository. category: Data, Text