cereal::PortableBinaryOutputArchive::Options Class Reference

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

#include <portable_binary.hpp>

Public Types
enum class	Endianness : std::uint8_t { big , little }
	Represents desired endianness. More...

Public Member Functions
	Options (Endianness outputEndian=getEndianness())
	Specify specific options for the PortableBinaryOutputArchive. More...

Static Public Member Functions
static Options	Default ()
	Default options, preserve system endianness. More...
static Options	LittleEndian ()
	Save as little endian. More...
static Options	BigEndian ()
	Save as big endian. More...

Private Member Functions
std::uint8_t	is_little_endian () const
	Checks if Options is set for little endian. More...

Static Private Member Functions
static Endianness	getEndianness ()
	Gets the endianness of the system. More...

Private Attributes
Endianness	itsOutputEndianness

Friends
class	PortableBinaryOutputArchive

Detailed Description

A class containing various advanced options for the PortableBinaryOutput archive.

Member Enumeration Documentation

Endianness

enum cereal::PortableBinaryOutputArchive::Options::Endianness : std::uint8_t

strong

Represents desired endianness.

Enumerator
big
little

Constructor & Destructor Documentation

Options()

cereal::PortableBinaryOutputArchive::Options::Options ( Endianness  outputEndian = getEndianness() )

inlineexplicit

Specify specific options for the PortableBinaryOutputArchive.

Parameters

outputEndian

The desired endianness of saved (output) data

Member Function Documentation

BigEndian()

static Options cereal::PortableBinaryOutputArchive::Options::BigEndian ( )

inlinestatic

Save as big endian.

Default()

static Options cereal::PortableBinaryOutputArchive::Options::Default ( )

inlinestatic

Default options, preserve system endianness.

getEndianness()

static Endianness cereal::PortableBinaryOutputArchive::Options::getEndianness ( )

inlinestaticprivate

Gets the endianness of the system.

is_little_endian()

std::uint8_t cereal::PortableBinaryOutputArchive::Options::is_little_endian ( ) const

inlineprivate

Checks if Options is set for little endian.

LittleEndian()

static Options cereal::PortableBinaryOutputArchive::Options::LittleEndian ( )

inlinestatic

Save as little endian.

Friends And Related Function Documentation

PortableBinaryOutputArchive

friend class PortableBinaryOutputArchive

friend

Member Data Documentation

itsOutputEndianness

Endianness cereal::PortableBinaryOutputArchive::Options::itsOutputEndianness

private

---

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

• /home/runner/work/NDDEM/NDDEM/src/Dem/cereal/archives/portable_binary.hpp