BloombergLP::baljsn::SimpleFormatter::openArray

Print the start of a named JSON array onto the output stream.

Synopsis

Declared in <baljsn_simpleformatter.h>

void
openArray(
    std::string_view const& name,
    ArrayFormattingStyle formattingStyle = e_REGULAR_ARRAY_FORMAT);

Description

Print onto the stream supplied at construction the sequence of characters designating the start of an array (referred to as an "array" in JSON) with the specified name, preceded, if necessary, by a comma. Optionally specify formattingStyle denoting if the array being opened should be formatted as an empty array. If formattingStyle is not specified then the array being opened is formatted as a regular array having elements. The behavior is undefined unless isNameNeeded() is true. Note that the formatting (and as a consequence the formattingStyle) is relevant only if this formatter encodes in the pretty style and is ignored otherwise.

Parameters

Name

Description

name

member name for the array

formattingStyle

whether to format the array as empty

Created with MrDocs