encodeMember overloads

Synopses

Declared in <baljsn_encodeimplutil.h>

Encode the JSON representation of object member named memberName.

static
int
encodeMember(
    bool* isMemberEmpty,
    FORMATTER* formatter,
    std::ostream* logStream,
    std::string_view const& memberName,
    bsl::vector<char> const& member,
    FormattingMode formattingMode,
    EncoderOptions const& options,
    bool isFirstMember,
    bdlat_TypeCategory::Array category);

» more...

Same as the preceding encodeMember overload for the specified category.

template<class TYPE>
static
int
encodeMember(
    bool* isMemberEmpty,
    FORMATTER* formatter,
    std::ostream* logStream,
    std::string_view const& memberName,
    TYPE const& member,
    FormattingMode formattingMode,
    EncoderOptions const& options,
    bool isFirstMember,
    bdlat_TypeCategory::Array category);

» more...

Same as the preceding encodeMember overload for the specified category.

template<
    class TYPE,
    class OTHER_CATEGORY>
static
int
encodeMember(
    bool* isMemberEmpty,
    FORMATTER* formatter,
    std::ostream* logStream,
    std::string_view const& memberName,
    TYPE const& member,
    FormattingMode formattingMode,
    EncoderOptions const& options,
    bool isFirstMember,
    OTHER_CATEGORY category);

» more...

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

isMemberEmpty

receives whether the member is empty

formatter

JSON formatter that receives the encoded tokens

logStream

stream for human‐readable error descriptions

memberName

name of the member to encode

member

member value to encode

formattingMode

formatting‐mode bit‐field for the member

options

encoding options

isFirstMember

if true, omit a leading sequence delimiter

category

bdlat Array type‐category tag

Created with MrDocs