cereal::PortableBinaryInputArchive::Options Class Reference

A class containing various advanced options for the PortableBinaryInput 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 inputEndian=getEndianness())
	Specify specific options for the PortableBinaryInputArchive. More...

Static Public Member Functions
static Options	Default ()
	Default options, preserve system endianness. More...
static Options	LittleEndian ()
	Load into little endian. More...
static Options	BigEndian ()
	Load into 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	itsInputEndianness

Friends
class	PortableBinaryInputArchive

Detailed Description

A class containing various advanced options for the PortableBinaryInput archive.

Member Enumeration Documentation

Endianness

enum cereal::PortableBinaryInputArchive::Options::Endianness : std::uint8_t

strong

Represents desired endianness.

Enumerator
big
little

Constructor & Destructor Documentation

Options()

cereal::PortableBinaryInputArchive::Options::Options ( Endianness  inputEndian = getEndianness() )

inlineexplicit

Specify specific options for the PortableBinaryInputArchive.

Parameters

inputEndian

The desired endianness of loaded (input) data

Member Function Documentation

BigEndian()

static Options cereal::PortableBinaryInputArchive::Options::BigEndian ( )

inlinestatic

Load into big endian.

Default()

static Options cereal::PortableBinaryInputArchive::Options::Default ( )

inlinestatic

Default options, preserve system endianness.

getEndianness()

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

inlinestaticprivate

Gets the endianness of the system.

is_little_endian()

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

inlineprivate

Checks if Options is set for little endian.

LittleEndian()

static Options cereal::PortableBinaryInputArchive::Options::LittleEndian ( )

inlinestatic

Load into little endian.

Friends And Related Function Documentation

PortableBinaryInputArchive

friend class PortableBinaryInputArchive

friend

Member Data Documentation

itsInputEndianness

Endianness cereal::PortableBinaryInputArchive::Options::itsInputEndianness

private

---

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

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