baljsn_decoderoptions

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Attributes
    • Implementation Note
  • Usage
    • Example 1: Creating and Populating an Options Object

Purpose

Provide an attribute class for specifying JSON decoding options.

Classes

• baljsn::DecoderOptions: options for decoding objects in the JSON format

See also

baljsn_decoder, baljsn_encoderoptions

Description

This component provides a single, simply constrained (value-semantic) attribute class, baljsn::DecoderOptions, that is used to specify options for decoding objects in the JSON format.

Attributes

Name                             Type  Default  Simple Constraints
------------------               ----  -------  ------------------
maxDepth                         int   32       >= 0
skipUnknownElements              bool  true     none
validateInputIsUtf8              bool  false    none
allowConsecutiveSeparators       bool  true     none
allowFormFeedAsWhitespace        bool  true     none
allowUnescapedControlCharacters  bool  true     none

• maxDepth: maximum depth of the decoded data
• skipUnknownElements: flag specifying if unknown elements are skipped
• validateInputIsUtf8: flag specifying whether UTF-8 correctness checking is enabled.
• allowConsecutiveSeparators: flag specifying if multiple consecutive separators – e.g., "a" :: 1, [ 1,, 2 ] – are accepted and treated as if one separator had been input.
• allowFormFeedAsWhitespace: flag specifying if the form-feed character, '\f', is treaded as whitespace in addition to , '\t', '
  ', '\r', and '\v'.
• allowUnescapedControlCharacters: flag specifying if unescaped (raw) control characters (e.g., '
  ', '
  ') are allowed in JSON strings. Otherwise, control characters are represented by multi-character sequences (e.g., '\t' or '\u000A').

Implementation Note

This file was generated from a script and was subsequently modified to add documentation and to make other changes. The steps to generate and update this file can be found in the doc/generating_codec_options.txt file.

Usage

This section illustrates intended use of this component.

Example 1: Creating and Populating an Options Object

This component is designed to be used at a higher level to set the options for decoding objects in the JSON format. This example shows how to create and populate an options object.

First, we default-construct a baljsn::DecoderOptions object:

const int  MAX_DEPTH             = 10;
const bool SKIP_UNKNOWN_ELEMENTS = false;
 
baljsn::DecoderOptions options;
assert(32   == options.maxDepth());
assert(true == options.skipUnknownElements());

Next, we populate that object to decode using a different maxDepth value and skipUnknownElements value:

options.setMaxDepth(MAX_DEPTH);
assert(MAX_DEPTH == options.maxDepth());
 
options.setSkipUnknownElements(SKIP_UNKNOWN_ELEMENTS);
assert(SKIP_UNKNOWN_ELEMENTS == options.skipUnknownElements());