README.md

taocpp/json Documentation

Work-in-Progress - will be finished for 1.0 release

• Project
• Overview
• Getting Started
• Installing and Using - TODO: Similar to PEGTL; merge with Getting Started?
• Common Use Cases
  • Include the right header
  • Read any JSON file
  • Parse any JSON string
  • Serialise a JSON Value to a string
  • Serialise with base64 strings for binary data
  • Serialise a JSON Value to an ostream
  • Create a Value with a JSON object
• Value Class
  • Overview
  • Value and Data Types
  • Creating Values
  • Accessing Values
  • Manipulating Values
  • Container Functions
  • Comparing Values
• Type Traits
  • Overview
  • Create JSON Value from (custom) type
  • Convert JSON Value into (custom) type
  • Compare JSON Value to (custom) type
  • Produce JSON Events from (custom) type
  • Consume a (custom) type from a parser
  • Default Key for Objects
  • Batteries Included
• Binding Traits
  • Types as Arrays
  • Types as Objects
  • Polymorphic Factory
  • Multiple Versions
• Events Interface
  • Overview
  • Consumer Interface
  • Arrays and Objects
  • Reduced Interface
  • Batteries Included
• Batteries Included
  • Default Traits
  • Additional Traits
  • Binding Traits
  • Events Producers
  • Events Consumers
  • Events Transformers
  • Convenience Functions
  • Conversion Utilities
• Advanced Use Cases
  • Custom Base Class for Values
  • Annotate with filename and line number
• Instance Sharing
  • String Views
  • Binary Views
  • Value Pointers
  • Opaque Pointers
  • Self Contained
  • Unsafe Functions
• Interoperability
  • General Notes
  • Specific Notes
    • JSON
    • JAXN
    • CBOR
    • MsgPack
    • UBJSON
  • Unsupported Formats
• Parser Interface
• Design Decisions
• Scratchpad
• Changelog

Copyright (c) 2018-2021 Dr. Colin Hirsch and Daniel Frey