#include <jsoncons_ext/cbor/cbor_cursor.hpp>
template<
class Source=jsoncons::binary_stream_source,
class Allocator=std::allocator<char>>
class basic_cbor_cursor;A pull parser for reporting CBOR parse events. A typical application will
repeatedly process the current() event and call the next()
function to advance to the next event, until done() returns true.
In addition, when positioned on a begin_object event,
the read_to function can pull a complete object representing
the events from begin_object to end_object,
and when positioned on a begin_array event, a complete array
representing the events from begin_array ro end_array.
basic_cbor_cursor is noncopyable and nonmoveable.
Aliases for common sources are provided:
| Type | Definition |
|---|---|
| cbor_stream_cursor | basic_cbor_cursorjsoncons::binary_stream_source |
| cbor_bytes_cursor | basic_cbor_cursorjsoncons::bytes_source |
basic_cbor_cursor(Sourceable&& source,
const cbor_decode_options& options = cbor_decode_options(),
const Allocator& alloc = Allocator()); (1)
template <class Sourceable>
basic_cbor_cursor(Sourceable&& source,
std::error_code& ec); (2)
template <class Sourceable>
basic_cbor_cursor(Sourceable&& source,
const cbor_decode_options& options,
std::error_code& ec); (3)
template <class Sourceable>
basic_cbor_cursor(std::allocator_arg_t, const Allocator& alloc,
Sourceable&& source,
const cbor_decode_options& options,
std::error_code& ec); (4)
Constructors (1) reads from a buffer or stream source and throws a ser_error if a parsing error is encountered while processing the initial event.
Constructors (2)-(4) read from a buffer or stream source and set ec
if a parsing error is encountered while processing the initial event.
Note: It is the programmer's responsibility to ensure that basic_cbor_cursor does not outlive any source passed in the constuctor,
as basic_cbor_cursor holds a pointer to but does not own this object.
source - a value from which a source_type is constructible.
bool done() const override;
Checks if there are no more events.
const staj_event& current() const override;
Returns the current staj_event.
void read_to(json_visitor& visitor) override
Feeds the current and succeeding staj events through the provided visitor, until the visitor indicates to stop. If a parsing error is encountered, throws a ser_error.
void read_to(json_visitor& visitor, std::error_code& ec) override
Feeds the current and succeeding staj events through the provided
visitor, until the visitor indicates
to stop. If a parsing error is encountered, sets ec.
void next() override;
Advances to the next event. If a parsing error is encountered, throws a ser_error.
void next(std::error_code& ec) override;
Advances to the next event. If a parsing error is encountered, sets ec.
const ser_context& context() const override;
Returns the current context
void reset();
Reset cursor to read another value from the same source
template <class Sourceable>
reset(Sourceable&& source)
Reset cursor to read new value from a new sources
template <class Source, class Allocator> staj_filter_view operator|(basic_cbor_cursor<Source,Allocator>& cursor, std::function<bool(const staj_event&, const ser_context&)> pred);
Input JSON file book_catalog.json:
[
{
"author" : "Haruki Murakami",
"title" : "Hard-Boiled Wonderland and the End of the World",
"isbn" : "0679743464",
"publisher" : "Vintage",
"date" : "1993-03-02",
"price": 18.90
},
{
"author" : "Graham Greene",
"title" : "The Comedians",
"isbn" : "0099478374",
"publisher" : "Vintage Classics",
"date" : "2005-09-21",
"price": 15.74
}
]#include <jsoncons_ext/cbor/cbor_cursor.hpp>
#include <string>
#include <fstream>
using namespace jsoncons;
int main()
{
std::ifstream is("book_catalog.json");
cbor_cursor cursor(is);
for (; !cursor.done(); cursor.next())
{
const auto& event = cursor.current();
switch (event.event_type())
{
case staj_event_type::begin_array:
std::cout << event.event_type() << "\n";
break;
case staj_event_type::end_array:
std::cout << event.event_type() << "\n";
break;
case staj_event_type::begin_object:
std::cout << event.event_type() << "\n";
break;
case staj_event_type::end_object:
std::cout << event.event_type() << "\n";
break;
case staj_event_type::key:
// Or std::string_view, if supported
std::cout << event.event_type() << ": " << event.get<jsoncons::string_view>() << "\n";
break;
case staj_event_type::string_value:
// Or std::string_view, if supported
std::cout << event.event_type() << ": " << event.get<jsoncons::string_view>() << "\n";
break;
case staj_event_type::null_value:
std::cout << event.event_type() << ": " << "\n";
break;
case staj_event_type::bool_value:
std::cout << event.event_type() << ": " << std::boolalpha << event.get<bool>() << "\n";
break;
case staj_event_type::int64_value:
std::cout << event.event_type() << ": " << event.get<int64_t>() << "\n";
break;
case staj_event_type::uint64_value:
std::cout << event.event_type() << ": " << event.get<uint64_t>() << "\n";
break;
case staj_event_type::half_value:
case staj_event_type::double_value:
std::cout << event.event_type() << ": " << event.get<double>() << "\n";
break;
default:
std::cout << "Unhandled event type\n";
break;
}
}
}Output:
begin_array
begin_object
key: author
string_value: Haruki Murakami
key: title
string_value: Hard-Boiled Wonderland and the End of the World
key: isbn
string_value: 0679743464
key: publisher
string_value: Vintage
key: date
string_value: 1993-03-02
key: price
double_value: 19
end_object
begin_object
key: author
string_value: Graham Greene
key: title
string_value: The Comedians
key: isbn
string_value: 0099478374
key: publisher
string_value: Vintage Classics
key: date
string_value: 2005-09-21
key: price
double_value: 16
end_object
end_array
#include <jsoncons_ext/cbor/cbor_cursor.hpp>
#include <string>
#include <fstream>
using namespace jsoncons;
int main()
{
bool author_next = false;
auto filter = [&](const staj_event& event, const ser_context&) -> bool
{
if (event.event_type() == staj_event_type::key &&
event.get<jsoncons::string_view>() == "author")
{
author_next = true;
return false;
}
if (author_next)
{
author_next = false;
return true;
}
return false;
};
std::ifstream is("book_catalog.json");
cbor_cursor cursor(is);
auto filtered_c = cursor | filter;
for (; !filtered_c.done(); filtered_c.next())
{
const auto& event = filtered_c.current();
switch (event.event_type())
{
case staj_event_type::string_value:
std::cout << event.get<jsoncons::string_view>() << "\n";
break;
}
}
}Output:
Haruki Murakami
Graham Greene
#include <jsoncons/json.hpp>
#include <jsoncons_ext/cbor/cbor.hpp>
#include <iostream>
#include <iomanip>
#include <cassert>
struct my_cbor_visitor : public default_json_visitor
{
std::vector<double> v;
private:
bool visit_typed_array(const span<const double>& data,
semantic_tag,
const ser_context&,
std::error_code&) override
{
v = std::vector<double>(data.begin(),data.end());
return false;
}
};
int main()
{
std::vector<double> v{10.0,20.0,30.0,40.0};
std::vector<uint8_t> buffer;
cbor::cbor_options options;
options.use_typed_arrays(true);
cbor::encode_cbor(v, buffer, options);
std::cout << "(1)\n";
std::cout << byte_string_view(buffer) << "\n\n";
/*
0xd8, // Tag
0x56, // Tag 86, float64, little endian, Typed Array
0x58,0x20, // Byte string value of length 32
0x00,0x00,0x00,0x00,0x00,0x00,0x24,0x40,
0x00,0x00,0x00,0x00,0x00,0x00,0x34,0x40,
0x00,0x00,0x00,0x00,0x00,0x00,0x3e,0x40,
0x00,0x00,0x00,0x00,0x00,0x00,0x44,0x40
*/
cbor::cbor_bytes_cursor cursor(buffer);
assert(cursor.current().event_type() == staj_event_type::begin_array);
assert(cursor.is_typed_array());
my_cbor_visitor visitor;
cursor.read_to(visitor);
std::cout << "(2)\n";
for (auto item : handler.v)
{
std::cout << item << "\n";
}
std::cout << "\n";
}Output:
(1)
d8 56 58 20 00 00 00 00 00 00 24 40 00 00 00 00 00 00 34 40 00 00 00 00 00 00 3e 40 00 00 00 00 00 00 44 40
(2)
10
20
30
40
This example is taken from CBOR Tags for Typed Arrays
#include <jsoncons_ext/cbor/cbor_cursor.hpp>
int main()
{
const std::vector<uint8_t> input = {
0xd8,0x28, // Tag 40 (multi-dimensional row major array)
0x82, // array(2)
0x82, // array(2)
0x02, // unsigned(2) 1st Dimension
0x03, // unsigned(3) 2nd Dimension
0xd8,0x41, // Tag 65 (uint16 big endian Typed Array)
0x4c, // byte string(12)
0x00,0x02, // unsigned(2)
0x00,0x04, // unsigned(4)
0x00,0x08, // unsigned(8)
0x00,0x04, // unsigned(4)
0x00,0x10, // unsigned(16)
0x01,0x00 // unsigned(256)
};
cbor::cbor_bytes_cursor cursor(input);
for (; !cursor.done(); cursor.next())
{
const auto& event = cursor.current();
switch (event.event_type())
{
case staj_event_type::begin_array:
std::cout << event.event_type()
<< " " << "(" << event.tag() << ")\n";
break;
case staj_event_type::end_array:
std::cout << event.event_type()
<< " " << "(" << event.tag() << ")\n";
break;
case staj_event_type::uint64_value:
std::cout << event.event_type()
<< ": " << event.get<uint64_t>() << " " << "(" << event.tag() << ")\n";
break;
default:
std::cout << "Unhandled event type " << event.event_type()
<< " " << "(" << event.tag() << ")\n";
break;
}
}
}Output:
begin_array (multi-dim-row-major)
begin_array (n/a)
uint64_value: 2 (n/a)
uint64_value: 3 (n/a)
end_array (n/a)
begin_array (n/a)
uint64_value: 2 (n/a)
uint64_value: 4 (n/a)
uint64_value: 8 (n/a)
uint64_value: 4 (n/a)
uint64_value: 10 (n/a)
uint64_value: 100 (n/a)
end_array (n/a)
end_array (n/a)
This example is taken from CBOR Tags for Typed Arrays
#include <jsoncons_ext/cbor/cbor_cursor.hpp>
int main()
{
const std::vector<uint8_t> input = {
0xd9,0x04,0x10, // Tag 1040 (multi-dimensional column major array)
0x82, // array(2)
0x82, // array(2)
0x02, // unsigned(2) 1st Dimension
0x03, // unsigned(3) 2nd Dimension
0x86, // array(6)
0x02, // unsigned(2)
0x04, // unsigned(4)
0x08, // unsigned(8)
0x04, // unsigned(4)
0x10, // unsigned(16)
0x19,0x01,0x00 // unsigned(256)
};
cbor::cbor_bytes_cursor cursor(input);
for (; !cursor.done(); cursor.next())
{
const auto& event = cursor.current();
switch (event.event_type())
{
case staj_event_type::begin_array:
std::cout << event.event_type()
<< " " << "(" << event.tag() << ")\n";
break;
case staj_event_type::end_array:
std::cout << event.event_type()
<< " " << "(" << event.tag() << ")\n";
break;
case staj_event_type::uint64_value:
std::cout << event.event_type()
<< ": " << event.get<uint64_t>() << " " << "(" << event.tag() << ")\n";
break;
default:
std::cout << "Unhandled event type " << event.event_type()
<< " " << "(" << event.tag() << ")\n";
break;
}
}
}Output:
begin_array (multi-dim-column-major)
begin_array (n/a)
uint64_value: 2 (n/a)
uint64_value: 3 (n/a)
end_array (n/a)
begin_array (n/a)
uint64_value: 2 (n/a)
uint64_value: 4 (n/a)
uint64_value: 8 (n/a)
uint64_value: 4 (n/a)
uint64_value: 10 (n/a)
uint64_value: 100 (n/a)
end_array (n/a)
end_array (n/a)