1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
### jsoncons::encode_json
Encode a C++ data structure to a JSON formatted string or stream. `encode_json` will work for all types that
have [json_type_traits](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/corelib/json_type_traits.md) defined.
```cpp
#include <jsoncons/encode_json.hpp>
template <typename T,typename CharContainer>
void encode_json(const T& val, CharContainer& cont,
const basic_json_encode_options<CharContainer::value_type>& options
= basic_json_encode_options<CharContainer::value_type>(),
indenting indent = indenting::no_indent); (1)
template <typename T,typename CharT>
void encode_json(const T& val, std::basic_ostream<CharT>& os,
const basic_json_encode_options<CharT>& options
= basic_json_encode_options<CharT>(),
indenting indent = indenting::no_indent); (2)
template <typename T,typename CharContainer>
void encode_json_pretty(const T& val, CharContainer& cont,
const basic_json_encode_options<CharContainer::value_type>& options
= basic_json_encode_options<CharContainer::value_type>()); (3) (since 0.155.0)
template <typename T,typename CharT>
void encode_json_pretty(const T& val, std::basic_ostream<CharT>& os,
const basic_json_encode_options<CharT>& options
= basic_json_encode_options<CharT>()); (4) (since 0.155.0)
template <typename T,typename CharT>
void encode_json(const T& val, basic_json_visitor<CharT>& encoder); (5)
template <typename T,typename CharContainer,typename Allocator,typename TempAllocator>
void encode_json(const allocator_set<Allocator,TempAllocator>& alloc_set,
const T& val, CharContainer& cont,
const basic_json_encode_options<CharContainer::value_type>& options
= basic_json_encode_options<CharContainer::value_type>(),
indenting indent = indenting::no_indent); (6) (since 0.171.0)
template <typename T,typename CharT,typename Allocator,typename TempAllocator>
void encode_json(const allocator_set<Allocator,TempAllocator>& alloc_set,
const T& val, std::basic_ostream<CharT>& os,
const basic_json_encode_options<CharT>& options
= basic_json_encode_options<CharT>(),
indenting indent = indenting::no_indent); (7) (since 0.171.0)
```
(1) Encode `val` into a character container with the specified (or defaulted) [options](basic_json_options.md).
(2) Encode `val` to an output stream with the specified (or defaulted) [options](basic_json_options.md).
Functions (3)-(4) are identical to (1)-(2) except indenting is on.
(5) Transform `val` into json events and stream through an encoder.
Functions (6)-(7) are identical to (1)-(2) except an [allocator_set](allocator_set.md) is passed as an additional argument.
#### Parameters
<table>
<tr>
<td>val</td>
<td>C++ data structure</td>
</tr>
<tr>
<td>visitor</td>
<td>JSON output visitor</td>
</tr>
<tr>
<td>options</td>
<td>Serialization options</td>
</tr>
<tr>
<td>os</td>
<td>Output stream</td>
</tr>
<tr>
<td>indenting</td>
<td><code>indenting::indent</code> to pretty print, <code>indenting::no_indent</code> for compact output</td>
</tr>
</table>
#### Return value
None
### Examples
#### Map with string-tuple pairs
```cpp
#include <iostream>
#include <map>
#include <tuple>
#include <jsoncons/json.hpp>
using namespace jsoncons;
int main()
{
using employee_collection = std::map<std::string,std::tuple<std::string,std::string,double>>;
employee_collection employees =
{
{"John Smith",{"Hourly","Software Engineer",10000}},
{"Jane Doe",{"Commission","Sales",20000}}
};
std::cout << "(1)\n" << '\n';
encode_json(employees,std::cout);
std::cout << "\n\n";
std::cout << "(2) Again, with pretty print\n" << '\n';
encode_json(employees, std::cout, indenting::indent);
}
```
Output:
```
(1)
{"Jane Doe":["Commission","Sales",20000.0],"John Smith":["Hourly","Software Engineer",10000.0]}
(2) Again, with pretty print
{
"Jane Doe": ["Commission","Sales",20000.0],
"John Smith": ["Hourly","Software Engineer",10000.0]
}
```
#### Contain JSON output in an object (prettified output)
```cpp
#include <iostream>
#include <map>
#include <tuple>
#include <jsoncons/json.hpp>
using namespace jsoncons;
int main()
{
std::map<std::string, std::tuple<std::string, std::string, double>> employees =
{
{"John Smith",{"Hourly","Software Engineer",10000}},
{"Jane Doe",{"Commission","Sales",20000}}
};
json_stream_encoder encoder(std::cout);
encoder.begin_object();
encoder.key("Employees");
encode_json(employees, encoder);
encoder.end_object();
encoder.flush();
}
```
Output:
```json
{
"Employees": {
"Jane Doe": ["Commission","Sales",20000.0],
"John Smith": ["Hourly","Software Engineer",10000.0]
}
}
```
#### Contain JSON output in an object (compressed output)
```cpp
#include <iostream>
#include <map>
#include <tuple>
#include <jsoncons/json.hpp>
using namespace jsoncons;
int main()
{
std::map<std::string, std::tuple<std::string, std::string, double>> employees =
{
{"John Smith",{"Hourly","Software Engineer",10000}},
{"Jane Doe",{"Commission","Sales",20000}}
};
compact_json_stream_encoder encoder(std::cout);
encoder.begin_object();
encoder.key("Employees");
encode_json(employees, encoder);
encoder.end_object();
encoder.flush();
}
```
Output:
```json
{"Employees":{"Jane Doe":["Commission","Sales",20000.0],"John Smith":["Hourly","Software Engineer",10000.0]}}
```
### See also
[basic_json_visitor](basic_json_visitor.md)
[basic_json_options](basic_json_options.md)
[basic_json_encoder](basic_json_encoder.md)
[decode_json](decode_json.md)
|
