v1::detail::BON8_encoder Class Reference

#include <hikogui/codec/BON8.hpp>

Public Member Functions
bstring const &	get () noexcept
	Return a byte_string of the encoded object.
void	add (signed long long value) noexcept
	And a signed integer.
void	add (unsigned long long value) noexcept
	And a unsigned integer.
void	add (signed long value) noexcept
	And a signed integer.
void	add (unsigned long value) noexcept
	And a unsigned integer.
void	add (signed int value) noexcept
	And a signed integer.
void	add (unsigned int value) noexcept
	And a unsigned integer.
void	add (signed short value) noexcept
	And a signed integer.
void	add (unsigned short value) noexcept
	And a unsigned integer.
void	add (signed char value) noexcept
	And a signed integer.
void	add (unsigned char value) noexcept
	And a unsigned integer.
void	add (double value) noexcept
	Add a floating point number.
void	add (float value) noexcept
	Add a floating point number.
void	add (bool value) noexcept
	Add a boolean.
void	add (nullptr_t value) noexcept
	Add a null.
void	add (std::string_view value) noexcept
	Add a UTF-8 string.
void	add (std::string const &value) noexcept
	Add a UTF-8 string.
void	add (char const *value) noexcept
	Add a UTF-8 string.
void	add (datum const &value)
	Add a datum.
template<typename T >
void	add (std::vector< T > const &items)
	Add a vector of values of the same type.
template<typename Key , typename Value >
void	add (std::map< Key, Value > const &items)
	Add a map of key/values pairs.

Detailed Description

BON8 encoder.

Member Function Documentation

add() [1/20]

void v1::detail::BON8_encoder::add ( bool value )

inlinenoexcept

Add a boolean.

Parameters

value

A boolean value.

add() [2/20]

void v1::detail::BON8_encoder::add ( char const * value )

inlinenoexcept

Add a UTF-8 string.

It is important that the UTF-8 string is valid.

Parameters

value

A UTF-8 string.

add() [3/20]

void v1::detail::BON8_encoder::add ( datum const & value )

inline

Add a datum.

Parameters

value

A datum.

add() [4/20]

void v1::detail::BON8_encoder::add ( double value )

inlinenoexcept

Add a floating point number.

Parameters

value

A floating point number.

add() [5/20]

void v1::detail::BON8_encoder::add ( float value )

inlinenoexcept

Add a floating point number.

Parameters

value

A floating point number.

add() [6/20]

void v1::detail::BON8_encoder::add ( nullptr_t value )

inlinenoexcept

Add a null.

Parameters

value

A null pointer.

add() [7/20]

void v1::detail::BON8_encoder::add ( signed char value )

inlinenoexcept

And a signed integer.

Parameters

value

A signed integer.

add() [8/20]

void v1::detail::BON8_encoder::add ( signed int value )

inlinenoexcept

And a signed integer.

Parameters

value

A signed integer.

add() [9/20]

void v1::detail::BON8_encoder::add ( signed long long value )

inlinenoexcept

And a signed integer.

Parameters

value

A signed integer.

add() [10/20]

void v1::detail::BON8_encoder::add ( signed long value )

inlinenoexcept

And a signed integer.

Parameters

value

A signed integer.

add() [11/20]

void v1::detail::BON8_encoder::add ( signed short value )

inlinenoexcept

And a signed integer.

Parameters

value

A signed integer.

add() [12/20]

template<typename Key , typename Value >

void v1::detail::BON8_encoder::add ( std::map< Key, Value > const & items )

inline

Add a map of key/values pairs.

Template Parameters

Key	A type convertible to a string_view; a valid UTF-8 string.
Value	The type of the Value.

Parameters

items

The map of key/value pairs.

add() [13/20]

void v1::detail::BON8_encoder::add ( std::string const & value )

inlinenoexcept

Add a UTF-8 string.

It is important that the UTF-8 string is valid.

Parameters

value

A UTF-8 string.

add() [14/20]

void v1::detail::BON8_encoder::add ( std::string_view value )

inlinenoexcept

Add a UTF-8 string.

It is important that the UTF-8 string is valid.

Parameters

value

A UTF-8 string.

add() [15/20]

template<typename T >

void v1::detail::BON8_encoder::add ( std::vector< T > const & items )

inline

Add a vector of values of the same type.

Template Parameters

T	Type of the values.

Parameters

items

A vector of values.

add() [16/20]

void v1::detail::BON8_encoder::add ( unsigned char value )

inlinenoexcept

And a unsigned integer.

Parameters

value

A unsigned integer.

add() [17/20]

void v1::detail::BON8_encoder::add ( unsigned int value )

inlinenoexcept

And a unsigned integer.

Parameters

value

A unsigned integer.

add() [18/20]

void v1::detail::BON8_encoder::add ( unsigned long long value )

inlinenoexcept

And a unsigned integer.

Parameters

value

A unsigned integer.

add() [19/20]

void v1::detail::BON8_encoder::add ( unsigned long value )

inlinenoexcept

And a unsigned integer.

Parameters

value

A unsigned integer.

add() [20/20]

void v1::detail::BON8_encoder::add ( unsigned short value )

inlinenoexcept

And a unsigned integer.

Parameters

value

A unsigned integer.

get()

bstring const & v1::detail::BON8_encoder::get ( )

inlinenoexcept

Return a byte_string of the encoded object.

---

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

• hikogui/src/hikogui/codec/BON8.hpp