dump.md

jsoncons::basic_json::dump, jsoncons::basic_json::dump_pretty

void dump(basic_json_visitor<char_type>& visitor) const;    (1)

template <CharContainer>
void dump(CharContainer& cont,
    const basic_json_encode_options<char_type>& options     (2)
        = basic_json_encode_options<char_type>()) const;                

void dump(std::basic_ostream<char_type>& os, 
    const basic_json_encode_options<char_type>& options     (3)
        = basic_json_encode_options<char_type>();                

template <CharContainer>
void dump_pretty(CharContainer& cont,
    const basic_json_encode_options<char_type>& options     (4)
        = basic_json_encode_options<char_type>()) const;    

void dump_pretty(std::basic_ostream<char_type>& os, 
    const basic_json_encode_options<char_type>& options     (5)
        = basic_json_encode_options<char_type>()) const;    

template <CharContainer>
void dump(CharContainer& cont,
    const basic_json_encode_options<char_type>& options,    (6) (deprecated since 1.4.0)
    indenting) const;                            
                                                            
template <CharContainer>
void dump(CharContainer& cont, indenting indent) const;     (7) (deprecated since 1.4.0)

void dump(std::basic_ostream<char_type>& os,                (8) (deprecated since 1.4.0)
    indenting indent) const;   

(1) Dumps a json value to the specified visitor.

(2) Dumps a json value to a character container with "minified" output (single line.)

(3) Dumps a json value to an output stream with "minified" output.

Functions (4)-(5) are identical to (2)-(3) except with "prettified" output (line indentation.)

Functions (6)-(8) that take an indenting argument are for backward compatibility, prefer dump_pretty.

Exceptions

Throws ser_error if there is a serialization error.

Examples

Dump json value to csv file

#include <jsoncons/json.hpp>
#include <jsoncons_ext/csv/csv.hpp>

using namespace jsoncons;

int main()
{
    const json books = json::parse(R"(
    [
        {
            "title" : "Kafka on the Shore",
            "author" : "Haruki Murakami",
            "price" : 25.17
        },
        {
            "title" : "Women: A Novel",
            "author" : "Charles Bukowski",
            "price" : 12.00
        },
        {
            "title" : "Cutter's Way",
            "author" : "Ivan Passer"
        }
    ]
    )");

    auto options = csv_options{}          
        .column_names("author,title,price");

    csv_stream_encoder encoder(std::cout, options);

    books.dump(encoder);
}

Output:

author,title,price
Haruki Murakami,Kafka on the Shore,25.17
Charles Bukowski,Women: A Novel,12.0
Ivan Passer,Cutter's Way,

Dump json content into a larger document

#include <jsoncons/json.hpp>

using namespace jsoncons;

int main()
{
    const json some_books = json::parse(R"(
    [
        {
            "title" : "Kafka on the Shore",
            "author" : "Haruki Murakami",
            "price" : 25.17
        },
        {
            "title" : "Women: A Novel",
            "author" : "Charles Bukowski",
            "price" : 12.00
        }
    ]
    )");

    const json more_books = json::parse(R"(
    [
        {
            "title" : "A Wild Sheep Chase: A Novel",
            "author" : "Haruki Murakami",
            "price" : 9.01
        },
        {
            "title" : "Cutter's Way",
            "author" : "Ivan Passer",
            "price" : 8.00
        }
    ]
    )");

    json_stream_encoder encoder(std::cout); // pretty print
    encoder.begin_array();
    for (const auto& book : some_books.array_range())
    {
        book.dump(encoder);
    }
    for (const auto& book : more_books.array_range())
    {
        book.dump(encoder);
    }
    encoder.end_array();
    encoder.flush();
}

Output:

[
    {
        "author": "Haruki Murakami",
        "price": 25.17,
        "title": "Kafka on the Shore"
    },
    {
        "author": "Charles Bukowski",
        "price": 12.0,
        "title": "Women: A Novel"
    },
    {
        "author": "Haruki Murakami",
        "price": 9.01,
        "title": "A Wild Sheep Chase: A Novel"
    },
    {
        "author": "Ivan Passer",
        "price": 8.0,
        "title": "Cutter's Way"
    }
]