encodeMemberPrefix overloads

Synopses

Declared in <baljsn_encodeimplutil.h>

Encode any needed comma and member‐name tokens before a member value.

static
int
encodeMemberPrefix(
    FORMATTER* formatter,
    std::ostream* logStream,
    std::string_view const& memberName,
    bool isFirstMember);

Same as the preceding encodeMemberPrefix overload, using the specified formattingMode.

static
int
encodeMemberPrefix(
    FORMATTER* formatter,
    std::ostream* logStream,
    std::string_view const& memberName,
    FormattingMode formattingMode,
    bool isFirstMember);

Same as the preceding encodeMemberPrefix overload, optionally loading isPrefixEmpty.

static
int
encodeMemberPrefix(
    bool* isPrefixEmpty,
    FORMATTER* formatter,
    std::ostream* logStream,
    std::string_view const& memberName,
    FormattingMode formattingMode,
    bool isFirstMember);

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

formatter

JSON formatter that receives the encoded tokens

logStream

stream for human‐readable error descriptions

memberName

name of the member

isFirstMember

if true, omit a leading comma

formattingMode

formatting‐mode bit‐field for the member

isPrefixEmpty

receives whether no prefix token was encoded

Created with MrDocs