cereal_PortableBinaryOutputArchive(3)

cereal::PortableBinaryOutputArchive(3)

Library Functions Manual

cereal::PortableBinaryOutputArchive(3)

NAME

cereal::PortableBinaryOutputArchive - An output archive designed to save data in a compact binary representation portable over different architectures.

SYNOPSIS

#include </home/build/include/cereal/archives/portable_binary.hpp>

Inherits cereal::OutputArchive< PortableBinaryOutputArchive, AllowEmptyClassElision >.

Classes

class Options
A class containing various advanced options for the PortableBinaryOutput archive.

PortableBinaryOutputArchive (std::ostream &stream, Options const &options=Options::Default())
Construct, outputting to the provided stream. template<std::streamsize DataSize> void saveBinary (const void *data, std::streamsize size)
Writes size bytes of data to the output stream.

Public Member Functions inherited from cereal::OutputArchive< PortableBinaryOutputArchive, AllowEmptyClassElision >
OutputArchive (PortableBinaryOutputArchive *const derived)
Construct the output archive. OutputArchive & operator= (OutputArchive const &)=delete
PortableBinaryOutputArchive & operator() (Types &&... args)
Serializes all passed in data. void serializeDeferments ()
Serializes any data marked for deferment using defer. std::uint32_t registerSharedPointer (const std::shared_ptr< const void > &sharedPointer)
Registers a shared pointer with the archive. std::uint32_t registerPolymorphicType (char const *name)
Registers a polymorphic type name with the archive.

PortableBinaryOutputArchive & operator& (T &&arg)
Serializes passed in data.

PortableBinaryOutputArchive & operator<< (T &&arg)
Serializes passed in data.

Public Member Functions inherited from cereal::detail::OutputArchiveBase
OutputArchiveBase (OutputArchiveBase &&) CEREAL_NOEXCEPT
OutputArchiveBase & operator= (OutputArchiveBase &&) CEREAL_NOEXCEPT

Additional Inherited Members

using is_loading
Indicates this archive is not intended for loading.

using is_saving
Indicates this archive is intended for saving.

Detailed Description

An output archive designed to save data in a compact binary representation portable over different architectures.

This archive outputs data to a stream in an extremely compact binary representation with as little extra metadata as possible.

This archive will record the endianness of the data as well as the desired in/out endianness and assuming that the user takes care of ensuring serialized types are the same size across machines, is portable over different architectures.

When using a binary archive and a file stream, you must use the std::ios::binary format flag to avoid having your data altered inadvertently.

Warning

This archive has not been thoroughly tested across different architectures. Please report any issues, optimizations, or feature requests at the project github.

Constructor & Destructor Documentation

cereal::PortableBinaryOutputArchive::PortableBinaryOutputArchive (std::ostream & stream, Options const & options = Options::Default()) [inline]

Construct, outputting to the provided stream.

Parameters

stream The stream to output to. Should be opened with std::ios::binary flag.
options The PortableBinary specific options to use. See the Options struct for the values of default parameters

Author

Generated automatically by Doxygen for cereal from the source code.

Sat Aug 29 2026 00:42:30

cereal