NorfairKing/autodocodec
1
1
Fork 0
mirror of https://github.com/NorfairKing/autodocodec.git synced 2024-12-02 09:52:01 +03:00
Code Issues Projects Releases Wiki Activity

more docs about bimap

Browse Source
This commit is contained in:
Tom Sydney Kerckhove 2021-11-15 10:52:16 +01:00
parent 2ba58cb1d3
commit ba37cd65e9
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
autodocodec/src/Autodocodec/Codec.hs
View File

@ -441,14 +441,12 @@ eitherCodec = EitherCodec
-- --
-- This function allows you to have the parsing fail in a new way. -- This function allows you to have the parsing fail in a new way.
-- --
-- If you use this function, then you will most likely want to add documentation about how not every value that the schema specifies will be accepted.
--
-- === Example usage -- === Example usage
-- --
-- > boundedIntegerCodec :: (Integral i, Bounded i) => JSONCodec i -- logLevelCodec :: JSONCodec LogLevel
-- > boundedIntegerCodec = bimapCodec go fromIntegral $ NumberCodec Nothing -- logLevelCodec = bimapCodec parseLogLevel renderLogLevel codec <?> "Valid values include DEBUG, INFO, WARNING, ERROR."
-- > where
-- > go s = case Scientific.toBoundedInteger s of
-- > Nothing -> Left $ "Number too big: " <> show s
-- > Just i -> Right i
bimapCodec :: bimapCodec ::
(oldOutput -> Either String newOutput) -> (oldOutput -> Either String newOutput) ->
(newInput -> oldInput) -> (newInput -> oldInput) ->