encode overloads

Synopses

Declared in <baljsn_encoder.h>

Encode the specified value of (template parameter) TYPE into the specified stream. Return 0 on success, and a non‐zero value otherwise. Note that stream will be invalidated if the encoding failed.

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 the specified value, of (template parameter) TYPE, in the JSON format using the specified options and output it onto the specified stream. Specifying a nullptr options is equivalent to passing a default‐constructed EncoderOptions in options. TYPE shall be a bdlat‐compatible choice, or array type, or a bdlat‐compatible dynamic type referring to one of those types. Return 0 on success, and a non‐zero value otherwise.

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 the specified value, of (template parameter) TYPE, in the JSON format using the specified options and output it onto the specified streamBuf. Specifying a nullptr options is equivalent to passing a default‐constructed EncoderOptions in options. TYPE shall be a bdlat‐compatible sequence, choice, or array type, or a bdlat‐compatible dynamic type referring to one of those types. Return 0 on success, and a non‐zero value otherwise.

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);

Created with MrDocs