serde< std::string > Struct Reference

serde for std::string items. More...

#include <serde.hpp>

Public Member Functions
void	serialize (std::ostream &os, const std::string *items, unsigned num) const
	Stream serialization.
void	deserialize (std::istream &is, std::string *items, unsigned num) const
	Stream deserialization.
size_t	serialize (void *ptr, size_t capacity, const std::string *items, unsigned num) const
	Raw bytes serialization.
size_t	deserialize (const void *ptr, size_t capacity, std::string *items, unsigned num) const
	Raw bytes deserialization.
size_t	size_of_item (const std::string &item) const
	Size of the given item.

Detailed Description

serde for std::string items.

This should produce sketches binary-compatible with ItemsSketch<String> with ArrayOfStringsSerDe in Java. The length of each string is stored as a 32-bit integer (historically), which may be too wasteful. Treat this as an example.

This implementation treats std::string as an arbitrary byte container. It does not check whether string contents are valid UTF-8.

Use a UTF-8-validating SerDe when cross-language portability is required.

Member Function Documentation

serialize() [1/2]

void serialize ( std::ostream &  os, const std::string *  items, unsigned  num  ) const

inline

Stream serialization.

Parameters

os	output stream
items	pointer to array of items
num	number of items

deserialize() [1/2]

void deserialize ( std::istream &  is, std::string *  items, unsigned  num  ) const

inline

Stream deserialization.

Parameters

is	input stream
items	pointer to array of items (items in the array are allocated but not initialized)
num	number of items

serialize() [2/2]

size_t serialize ( void *  ptr, size_t  capacity, const std::string *  items, unsigned  num  ) const

inline

Raw bytes serialization.

Parameters

ptr	pointer to output buffer
capacity	size of the buffer in bytes
items	pointer to array of items
num	number of items

deserialize() [2/2]

size_t deserialize ( const void *  ptr, size_t  capacity, std::string *  items, unsigned  num  ) const

inline

Raw bytes deserialization.

Parameters

ptr	pointer to input buffer
capacity	size of the buffer in bytes
items	pointer to array of items (items in the array are allocated but not initialized)
num	number of items

size_of_item()

size_t size_of_item ( const std::string &  item ) const

inline

Size of the given item.

Parameters

item	to be sized

Returns

size of the given item in bytes

---

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

• common/include/serde.hpp