[#BloombergLP-baljsn-EncodeImplUtil-encode-0a]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baljsn.adoc[baljsn]::xref:BloombergLP/baljsn/EncodeImplUtil.adoc[EncodeImplUtil]::encode
:relfileprefix: ../../../
:mrdocs:

`encode` overloads

== Synopses

Declared in `<baljsn_encodeimplutil.h>`

Encode the JSON representation of the specified `value` to the specified `jsonStream`. Optionally specify `options` to configure aspects of the JSON representation of the `value`. If `options` is not specified, the default `EncoderOptions` value is used. Return 0 on success, and a non‐zero value otherwise. The behavior is undefined unless the specified `TYPE` satisfies both the static and dynamic requirements of one `bdlat` type‐category concept. See `baljsn_encoderoptions` for a description of the effects, if any, of each option in the `options` on the JSON representation of the `value`. See the package‐level documentation of `bdlat` for a description of the available type‐category concepts.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
static
int
xref:BloombergLP/baljsn/EncodeImplUtil/encode-0e.adoc[encode](
    std::ostream* jsonStream,
    TYPE const& value,
    xref:BloombergLP/baljsn/EncoderOptions.adoc[EncoderOptions] const& options = EncoderOptions());
----

[.small]#xref:BloombergLP/baljsn/EncodeImplUtil/encode-0e.adoc[_» more..._]#

Encode the JSON representation of the specified `value` to the specified `jsonStream`. If this operation is not successful, load an unspecified, human‐readable description of the error condition to the specified `logStream`. Optionally specify `options` to configure aspects of the JSON representation of the `value`. If `options` is not specified, the default `EncoderOptions` value is used. Return 0 on success, and a non‐zero value otherwise. The behavior is undefined unless the specified `TYPE` satisfies both the static and dynamic requirements of one `bdlat` type‐category concept. See `baljsn_encoderoptions` for a description of the effects, if any, of each option in the `options` on the JSON representation of the `value`. See the package‐level documentation of `bdlat` for an introduction to the requirements of `bdlat` type‐category concepts.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
static
int
xref:BloombergLP/baljsn/EncodeImplUtil/encode-0b1.adoc[encode](
    std::ostream* logStream,
    std::ostream* jsonStream,
    TYPE const& value,
    xref:BloombergLP/baljsn/EncoderOptions.adoc[EncoderOptions] const& options = EncoderOptions());
----

[.small]#xref:BloombergLP/baljsn/EncodeImplUtil/encode-0b1.adoc[_» more..._]#

Encode the JSON representation of the specified `value` to the specified JSON `formatter`, according to the specified `formattingMode`. If the representation contains no text, load the value `true` into `isValueEmpty` and the value `false` otherwise. If the specified `isFirstMember` option is `true`, then the representation of the value contains no leading sequence delimiter, and does contain such a delimiter if the remaining representation is non‐empty otherwise. Use the specified `options` to configure aspects of the JSON representation of the `value`. If this operation is not successful, load an unspecified, human‐readable description of the error condition to the specified `logStream`. Return 0 on success, and a non‐zero value otherwise. The behavior is undefined unless the specified `TYPE` satisfies both the static and dynamic requirements of one of the `bdlat` type‐category concepts. See `baljsn_encoderoptions` for a description of the effects, if any, of each option in the `options` on the JSON representation of the `value`. See the package‐level documentation of `bdlat` for an introduction to the requirements of `bdlat` type‐category concepts.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
static
int
xref:BloombergLP/baljsn/EncodeImplUtil/encode-0be.adoc[encode](
    bool* isValueEmpty,
    FORMATTER* formatter,
    std::ostream* logStream,
    TYPE const& value,
    xref:BloombergLP/baljsn/EncodeImplUtil/FormattingMode.adoc[FormattingMode] formattingMode,
    xref:BloombergLP/baljsn/EncoderOptions.adoc[EncoderOptions] const& options,
    bool isFirstMember);
----

[.small]#xref:BloombergLP/baljsn/EncodeImplUtil/encode-0be.adoc[_» more..._]#


[.small]#Created with https://www.mrdocs.com[MrDocs]#