MsgpackSchemaPacker Struct Reference

#include <schema_impl.hpp>

Inheritance diagram for MsgpackSchemaPacker:

Public Member Functions
	MsgpackSchemaPacker (msgpack::sbuffer &stream)
bool	set_emitted (const std::string &type)
void	pack_alias (const std::string &schema_name, const std::string &msgpack_name)
template<typename T >
void	pack_schema (const T &obj)
template<typename... Args>
void	pack_template_type (const std::string &schema_name)
template<msgpack_concepts::HasMsgPack T>
void	pack_with_name (const std::string &type, T const &object)
	Encode a type that defines msgpack based on its key value pairs.

Public Attributes
std::set< std::string >	emitted_types

Detailed Description

Define a serialization schema based on compile-time information about a type being serialized. This is then consumed by typescript to make bindings.

Definition at line 18 of file schema_impl.hpp.

Constructor & Destructor Documentation

MsgpackSchemaPacker()

MsgpackSchemaPacker::MsgpackSchemaPacker ( msgpack::sbuffer &  stream )

inline

Definition at line 19 of file schema_impl.hpp.

Member Function Documentation

pack_alias()

void MsgpackSchemaPacker::pack_alias ( const std::string &  schema_name, const std::string &  msgpack_name  )

inline

Pack a type indicating it is an alias of a certain msgpack type Packs in the form ["alias", [schema_name, msgpack_name]]

Parameters

schema_name	The CPP type.
msgpack_name	The msgpack type.

Definition at line 40 of file schema_impl.hpp.

pack_schema()

template<typename T >

void MsgpackSchemaPacker::pack_schema ( const T &  obj )

inline

Pack the schema of a given object.

Template Parameters

T	the object's type.

Parameters

obj	the object.

Definition at line 56 of file schema_impl.hpp.

pack_template_type()

template<typename... Args>

void MsgpackSchemaPacker::pack_template_type ( const std::string &  schema_name )

inline

Definition at line 60 of file schema_impl.hpp.

pack_with_name()

template<msgpack_concepts::HasMsgPack T>

void MsgpackSchemaPacker::pack_with_name ( const std::string &  type, T const &  object  )

inline

Encode a type that defines msgpack based on its key value pairs.

Template Parameters

T	the msgpack()'able type

Parameters

packer	Our special packer.
object	The object in question.

Definition at line 78 of file schema_impl.hpp.

set_emitted()

bool MsgpackSchemaPacker::set_emitted ( const std::string &  type )

inline

Definition at line 25 of file schema_impl.hpp.

Member Data Documentation

emitted_types

std::set<std::string> MsgpackSchemaPacker::emitted_types

Definition at line 23 of file schema_impl.hpp.

---

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

• src/barretenberg/serialize/msgpack_impl/schema_impl.hpp