encode overloads

Synopses

Declared in <baljsn_encoder.h>

Encode value as JSON onto stream using default options.

template<class TYPE>
int
encode(
    std::ostream& stream,
    TYPE const& value);

Encode the specified value of (template parameter) TYPE into the specified streamBuf. Return 0 on success, and a non‐zero value otherwise.

template<class TYPE>
int
encode(
    std::streambuf* streamBuf,
    TYPE const& value);

Encode value as JSON onto stream using options.

template<class TYPE>
int
encode(
    std::ostream& stream,
    TYPE const& value,
    EncoderOptions const& options);

Same as the preceding overload, accepting a nullable options pointer.

template<class TYPE>
int
encode(
    std::ostream& stream,
    TYPE const& value,
    EncoderOptions const* options);

Encode value as JSON onto streamBuf using options.

template<class TYPE>
int
encode(
    std::streambuf* streamBuf,
    TYPE const& value,
    EncoderOptions const& options);

Same as the preceding overload, accepting a nullable options pointer.

template<class TYPE>
int
encode(
    std::streambuf* streamBuf,
    TYPE const& value,
    EncoderOptions const* options);

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

stream

output stream for JSON

value

value to encode

streamBuf

output buffer for JSON

options

encoding options

Created with MrDocs