jsonv::ostream_pretty_encoder Class Reference

Like ostream_encoder, but pretty prints output to an std::ostream. More...

#include <jsonv/encode.hpp>

Inheritance diagram for jsonv::ostream_pretty_encoder:

Collaboration diagram for jsonv::ostream_pretty_encoder:

Public Member Functions
	ostream_pretty_encoder (std::ostream &output, std::size_t indent_size=2)
	Create an instance which places text into output.
Public Member Functions inherited from jsonv::ostream_encoder
	ostream_encoder (std::ostream &output)
	Create an instance which places text into output.
void	ensure_ascii (bool value)
	If set to true (the default), then all non-ASCII characters in strings will be replaced with their numeric encodings.
Public Member Functions inherited from jsonv::encoder
void	encode (const jsonv::value &source)
	Encode some source value into this encoder, through write_tree.

Protected Member Functions
virtual void	write_null () override
	Write the null value.
virtual void	write_object_begin () override
	Write the opening of an object value.
virtual void	write_object_end () override
	Write the closing of an object value.
virtual void	write_object_key (std::string_view key) override
	Write the key for an object, including the separator.
virtual void	write_object_delimiter () override
	Write the delimiter between two entries in an object.
virtual void	write_array_begin () override
	Write the opening of an array value.
virtual void	write_array_end () override
	Write the closing of an array value.
virtual void	write_array_delimiter () override
	Write the delimiter between two entries in an array.
virtual void	write_string (std::string_view value) override
	Write a string value.
virtual void	write_integer (std::int64_t value) override
	Write an integer value.
virtual void	write_decimal (double value) override
	When a special value is given, this will output null.
virtual void	write_boolean (bool value) override
	Write a boolean value.
Protected Member Functions inherited from jsonv::ostream_encoder
std::ostream &	output ()
Protected Member Functions inherited from jsonv::encoder
virtual void	write_tree (jsonv::value &&source)
	Write source and everything under it as one value, taking it over.
virtual void	write_tree (const jsonv::value &source)
	Write source and everything under it as one value.

Detailed Description

Like ostream_encoder, but pretty prints output to an std::ostream.

For example, to pretty-print JSON to std::cout:

jsonv::ostream_pretty_encoder encoder(std::cout);
encoder.encode(some_value);
encoder.encode(another_value);

Definition at line 241 of file encode.hpp.

Member Function Documentation

write_array_begin()

virtual void jsonv::ostream_pretty_encoder::write_array_begin ( )

overrideprotectedvirtual

Write the opening of an array value.

[

Reimplemented from jsonv::ostream_encoder.

write_array_delimiter()

virtual void jsonv::ostream_pretty_encoder::write_array_delimiter ( )

overrideprotectedvirtual

Write the delimiter between two entries in an array.

,

Reimplemented from jsonv::ostream_encoder.

write_array_end()

virtual void jsonv::ostream_pretty_encoder::write_array_end ( )

overrideprotectedvirtual

Write the closing of an array value.

]

Reimplemented from jsonv::ostream_encoder.

write_boolean()

virtual void jsonv::ostream_pretty_encoder::write_boolean ( bool  value )

overrideprotectedvirtual

Write a boolean value.

true

Reimplemented from jsonv::ostream_encoder.

write_decimal()

virtual void jsonv::ostream_pretty_encoder::write_decimal ( double  value )

overrideprotectedvirtual

When a special value is given, this will output null.

Reimplemented from jsonv::ostream_encoder.

write_integer()

virtual void jsonv::ostream_pretty_encoder::write_integer ( std::int64_t  value )

overrideprotectedvirtual

Write an integer value.

902

Reimplemented from jsonv::ostream_encoder.

write_null()

virtual void jsonv::ostream_pretty_encoder::write_null ( )

overrideprotectedvirtual

Write the null value.

null

Reimplemented from jsonv::ostream_encoder.

write_object_begin()

virtual void jsonv::ostream_pretty_encoder::write_object_begin ( )

overrideprotectedvirtual

Write the opening of an object value.

{

Reimplemented from jsonv::ostream_encoder.

write_object_delimiter()

virtual void jsonv::ostream_pretty_encoder::write_object_delimiter ( )

overrideprotectedvirtual

Write the delimiter between two entries in an object.

,

Reimplemented from jsonv::ostream_encoder.

write_object_end()

virtual void jsonv::ostream_pretty_encoder::write_object_end ( )

overrideprotectedvirtual

Write the closing of an object value.

}

Reimplemented from jsonv::ostream_encoder.

write_object_key()

virtual void jsonv::ostream_pretty_encoder::write_object_key ( std::string_view  key )

overrideprotectedvirtual

Write the key for an object, including the separator.

"key":

Reimplemented from jsonv::ostream_encoder.

write_string()

virtual void jsonv::ostream_pretty_encoder::write_string ( std::string_view  value )

overrideprotectedvirtual

Write a string value.

Parameters

value

is the string to write. It will hopefully be encoded as valid UTF-8. It is the implementation's choice of how to deal with malformed string values. Two common options are to replace malformed sequences with ?s or to simply output these encodings and let the receiver deal with them.

"value"

Reimplemented from jsonv::ostream_encoder.

---

The documentation for this class was generated from the following file:

• jsonv/encode.hpp