cereal_BinaryOutputArchive(3) — Chainguard OS Manuals

cereal::BinaryOutputArchive(3)

Library Functions Manual

cereal::BinaryOutputArchive(3)

NAME

cereal::BinaryOutputArchive - An output archive designed to save data in a compact binary representation.

SYNOPSIS

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

Inherits cereal::OutputArchive< BinaryOutputArchive, AllowEmptyClassElision >.

BinaryOutputArchive (std::ostream &stream)
Construct, outputting to the provided stream. void saveBinary (const void *data, std::streamsize size)
Writes size bytes of data to the output stream.

Public Member Functions inherited from cereal::OutputArchive< BinaryOutputArchive, AllowEmptyClassElision >
OutputArchive (BinaryOutputArchive *const derived)
Construct the output archive. OutputArchive & operator= (OutputArchive const &)=delete
BinaryOutputArchive & 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.

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

BinaryOutputArchive & 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.

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

This archive does nothing to ensure that the endianness of the saved and loaded data is the same. If you need to have portability over architectures with different endianness, use PortableBinaryOutputArchive.

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.

Constructor & Destructor Documentation

cereal::BinaryOutputArchive::BinaryOutputArchive (std::ostream & stream) [inline]

Construct, outputting to the provided stream.

Parameters

stream The stream to output to. Can be a stringstream, a file stream, or even cout!

Author

Generated automatically by Doxygen for cereal from the source code.

Mon Oct 26 2026 20:39:03

cereal