Welcome to the Hydrant Documentation¶
Hydrant is a simple object serializer and data mapper library. Its goal is to parse JSON into value objects that you can safely use throughout your application. All the input validation and error checking can be done through Hydrant.
New? Install Hydrant and then jump in with getting started.
- Topical guides after getting started
- Learn how Hydrant’s error handling system works
- Read up on mapping techniques for some parsing scenarios that Hydrant can handle.
- Understand Hydrant’s design
- Learn how to write your own mappers.
- Hydrant’s Public API reference
- About Hydrant’s Development
- Review what’s changed between versions.
- Read the Contributor’s Guide.
- Bugs? File bugs on GitHub. Don’t know the best way? Read filing bugs.
Table of Contents¶
- Installation
- Getting Started
- Handling Hydrant Errors
- Mapping Techniques
- Writing Your Own Mappers
- Design
- Mapper Reference
- Thread Safety
- Constructor Helper Functions
- The Reverse Mapper
- HYDMapEnum
- HYDMapIdentity
- HYDMapObjectToStringByFormatter
- HYDMapStringToObjectByFormatter
- HYDMapDateToNumberSince
- HYDMapNumberToDateSince
- HYDMapDateToString
- HYDMapStringToDate
- HYDMapStringToNumber
- HYDMapNumberToString
- HYDMapURLToString
- HYDMapStringToURL
- HYDMapUUIDToString
- HYDMapStringToUUID
- HYDMapValue
- HYDMapReverseValue
- HYDMapForward
- HYDMapBackward
- HYDMapCollectionOf / HYDMapArrayOf
- HYDMapFirst
- HYDMapSplit
- HYDMapNonFatally
- HYDMapNotNull
- HYDMapOptionally
- HYDMapTypes
- HYDMapKVCObject
- HYDMapObject
- HYDMapWithBlock
- HYDMapWithPostProcessing
- HYDMapReflectively
- HYDMapThread
- HYDMapDispatch
- Accessor Reference
- Formatter Reference
- Value Transformer Reference
- Contributing to Hydrant
- Changelog