terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder > Class Template Reference

#include <InputArchive.h>

Inheritance diagram for terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >:

Collaboration diagram for terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >:

Public Types
using	SizeType = TSize
using	OffsetType = TOffset

Public Member Functions
	ExtendableBinaryInputArchive (TExtender *extender, TStream *stream_)
bool	isOk ()
void	sync ()
void	label (const char *)
Public Member Functions inherited from terse::Archive< TExtender >
	Archive (TExtender *impl_)
bool	isOk ()
void	sync ()
void	label (const char *value)
void	operator() (Args &&... args)
TExtender &	operator<< (TSerializable &source)
TExtender &	operator>> (TSerializable &dest)
void *	getUserData () const
void	setUserData (void *data)

Static Public Member Functions
static constexpr Endianness	endianness ()

Protected Member Functions
template<typename T >
void	process (Transparent< T > &&dest)
void	process (Anchor< OffsetType > &dest)
void	process (ArchiveOffset< OffsetType > &dest)
void	process (typename ArchiveOffset< OffsetType >::Proxy &dest)
void	process (typename ArchiveOffset< OffsetType >::Proxy &&dest)
void	process (ArchiveSize< SizeType, OffsetType > &dest)
void	process (typename ArchiveSize< SizeType, OffsetType >::Proxy &dest)
void	process (typename ArchiveSize< SizeType, OffsetType >::Proxy &&dest)
template<typename T , typename ... Args>
void	process (Blob< T, Args... > &dest)
template<typename T >
std::enable_if< traits::has_load_member< T >::value, void >::type	process (T &dest)
template<typename T >
std::enable_if< traits::has_serialize_member< T >::value, void >::type	process (T &dest)
template<typename T >
std::enable_if< traits::has_load_function< T >::value, void >::type	process (T &dest)
template<typename T >
std::enable_if< traits::has_serialize_function< T >::value, void >::type	process (T &dest)
template<typename T >
std::enable_if<!traits::has_load_member< T >::value &&!traits::has_serialize_member< T >::value &&!traits::has_load_function< T >::value &&!traits::has_serialize_function< T >::value, void >::type	process (T &dest)
template<typename T , std::size_t N>
void	process (std::array< T, N > &dest)
template<typename T , typename ... Args>
void	process (std::vector< T, Args... > &dest)
template<typename T , typename ... Args>
void	process (DynArray< T, Args... > &dest)
template<typename T , typename ... Args>
void	process (std::basic_string< T, Args... > &dest)
template<typename K , typename V >
void	process (std::pair< K, V > &dest)
template<typename K , typename V >
void	process (std::tuple< K, V > &dest)
std::size_t	processSize ()
template<class TContainer >
std::enable_if<!traits::is_batchable< TContainer >::value &&traits::has_reserve_member< TContainer >::value &&traits::has_push_back_member< TContainer >::value >::type	processElements (TContainer &dest, std::size_t size)
template<class TContainer >
std::enable_if<!traits::is_batchable< TContainer >::value &&!traits::has_reserve_member< TContainer >::value &&!traits::has_push_back_member< TContainer >::value >::type	processElements (TContainer &dest, std::size_t size)
template<class TContainer >
std::enable_if< traits::is_batchable< TContainer >::value &&traits::has_wide_elements< TContainer >::value >::type	processElements (TContainer &dest, std::size_t size)
template<class TContainer >
std::enable_if< traits::is_batchable< TContainer >::value &&!traits::has_wide_elements< TContainer >::value >::type	processElements (TContainer &dest, std::size_t size)
Protected Member Functions inherited from terse::Archive< TExtender >
void	dispatch (Head &&head)
void	dispatch (Head &&head, Tail &&... tail)

Private Types
using	BaseArchive = Archive< TExtender >

Private Member Functions
template<class TContainer >
void	resize (TContainer &dest, std::size_t size)
template<typename T , class TAllocator >
void	resize (DynArray< T, TAllocator > &dest, std::size_t size)

Private Attributes
TStream *	stream

Member Typedef Documentation

BaseArchive

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

using terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::BaseArchive = Archive<TExtender>

private

OffsetType

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

using terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::OffsetType = TOffset

SizeType

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

using terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::SizeType = TSize

Constructor & Destructor Documentation

ExtendableBinaryInputArchive()

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::ExtendableBinaryInputArchive ( TExtender *  extender, TStream *  stream_  )

inline

                                                                            : BaseArchive{extender}, stream{stream_} {
        }

Member Function Documentation

endianness()

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

static constexpr Endianness terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::endianness ( )

inlinestaticconstexpr

                                                 {
            return EByteOrder;
        }

isOk()

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

bool terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::isOk ( )

inline

                    {
            return true;
        }

label()

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::label ( const char *  )

inline

                                   {
        }

process() [1/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( Anchor< OffsetType > &  dest )

inlineprotected

                                               {
            dest.value = static_cast<OffsetType>(stream->tell());
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream, and terse::Anchor< TOffset >::value.

process() [2/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( ArchiveOffset< OffsetType > &  dest )

inlineprotected

                                                      {
            // Load the offset value itself (this points forward within the stream to the position of
            // the data with which the offset is associated)
            process(dest.value);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process(), and terse::ArchiveOffset< TOffset >::value.

process() [3/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( ArchiveSize< SizeType, OffsetType > &  dest )

inlineprotected

                                                              {
            // Load the size value itself (this value can be combined with an offset to get the end of a data region)
            process(dest.value);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process(), and terse::ArchiveSize< TSize, TOffset >::value.

process() [4/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T , typename ... Args>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( Blob< T, Args... > &  dest )

inlineprotected

                                             {
            using ValueType = typename Blob<T, Args...>::value_type;
            // Blob relies on a predetermined (user specified) size of how much data it should consume
            if (dest.size() != 0ul) {
                // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
                stream->read(reinterpret_cast<char*>(dest.data()), dest.size() * sizeof(ValueType));
            }
        }

References terse::Blob< T, TAllocator >::data(), terse::Blob< T, TAllocator >::size(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream.

process() [5/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T , typename ... Args>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( DynArray< T, Args... > &  dest )

inlineprotected

                                                 {
            const auto size = processSize();
            processElements(dest, size);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processSize().

process() [6/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T , std::size_t N>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( std::array< T, N > &  dest )

inlineprotected

                                           {
            for (auto& element : dest) {
                BaseArchive::dispatch(element);
            }
        }

References terse::Archive< TExtender >::dispatch().

process() [7/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T , typename ... Args>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( std::basic_string< T, Args... > &  dest )

inlineprotected

                                                        {
            const auto size = processSize();
            processElements(dest, size);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processSize().

process() [8/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename K , typename V >

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( std::pair< K, V > &  dest )

inlineprotected

                                          {
            BaseArchive::dispatch(dest.first);
            BaseArchive::dispatch(dest.second);
        }

References terse::Archive< TExtender >::dispatch().

process() [9/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename K , typename V >

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( std::tuple< K, V > &  dest )

inlineprotected

                                           {
            BaseArchive::dispatch(std::get<0>(dest));
            BaseArchive::dispatch(std::get<1>(dest));
        }

References terse::Archive< TExtender >::dispatch().

process() [10/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T , typename ... Args>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( std::vector< T, Args... > &  dest )

inlineprotected

                                                  {
            const auto size = processSize();
            processElements(dest, size);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processSize().

process() [11/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T >

std::enable_if< traits::has_load_member< T >::value, void >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( T &  dest )

inlineprotected

                                                           {
            dest.load(*static_cast<TExtender*>(this));
        }

process() [12/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T >

std::enable_if< traits::has_serialize_member< T >::value, void >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( T &  dest )

inlineprotected

                                                           {
            dest.serialize(*static_cast<TExtender*>(this));
        }

process() [13/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T >

std::enable_if< traits::has_load_function< T >::value, void >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( T &  dest )

inlineprotected

                                                           {
            load(*static_cast<TExtender*>(this), dest);
        }

process() [14/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T >

std::enable_if< traits::has_serialize_function< T >::value, void >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( T &  dest )

inlineprotected

                                                           {
            serialize(*static_cast<TExtender*>(this), dest);
        }

process() [15/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T >

std::enable_if<!traits::has_load_member< T >::value &&!traits::has_serialize_member< T >::value &&!traits::has_load_function< T >::value &&!traits::has_serialize_function< T >::value, void >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( T &  dest )

inlineprotected

                                                           {
            // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
            stream->read(reinterpret_cast<char*>(&dest), sizeof(T));
            SwapFrom<EByteOrder>::swap(dest);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream.

process() [16/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T >

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( Transparent< T > &&  dest )

inlineprotected

                                            {
            process(dest.data);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process().

Referenced by terse::BinaryInputArchive< TStream, TSize, TOffset, EByteOrder >::process(), terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processSize().

process() [17/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( typename ArchiveOffset< OffsetType >::Proxy &&  dest )

inlineprotected

                                                                     {
            process(dest);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process().

process() [18/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( typename ArchiveOffset< OffsetType >::Proxy &  dest )

inlineprotected

                                                                    {
            // Rely on the offset value stored in the associated `ArchiveOffset` and seek to it
            stream->seek(dest.target->value);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream, terse::ArchiveOffset< TOffset >::Proxy::target, and terse::ArchiveOffset< TOffset >::value.

process() [19/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( typename ArchiveSize< SizeType, OffsetType >::Proxy &&  dest )

inlineprotected

                                                                             {
            process(dest);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process().

process() [20/20]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process ( typename ArchiveSize< SizeType, OffsetType >::Proxy &  dest )

inlineprotected

                                                                            {
            // Calculate the offset + size value stored in the associated `ArchiveSize` and `Anchor` and seek to it
            assert(dest.base != nullptr);
            stream->seek(dest.base->value + dest.target->value);
        }

References terse::ArchiveSize< TSize, TOffset >::Proxy::base, terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream, terse::ArchiveSize< TSize, TOffset >::Proxy::target, and terse::ArchiveSize< TSize, TOffset >::value.

processElements() [1/4]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<class TContainer >

std::enable_if<!traits::is_batchable< TContainer >::value &&traits::has_reserve_member< TContainer >::value &&traits::has_push_back_member< TContainer >::value >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements ( TContainer &  dest, std::size_t  size  )

inlineprotected

                                                          {
            using ValueType = typename TContainer::value_type;
            dest.clear();
            dest.reserve(size);
            for (std::size_t i = 0ul; i < size; ++i) {
                dest.push_back(impl::ValueFactory<ValueType>::create(dest.get_allocator()));
                BaseArchive::dispatch(dest.back());
            }
        }

References terse::Archive< TExtender >::dispatch().

Referenced by terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process().

processElements() [2/4]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<class TContainer >

std::enable_if<!traits::is_batchable< TContainer >::value &&!traits::has_reserve_member< TContainer >::value &&!traits::has_push_back_member< TContainer >::value >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements ( TContainer &  dest, std::size_t  size  )

inlineprotected

                                                          {
            resize(dest, size);
            for (auto& element : dest) {
                BaseArchive::dispatch(element);
            }
        }

References terse::Archive< TExtender >::dispatch(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::resize().

processElements() [3/4]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<class TContainer >

std::enable_if< traits::is_batchable< TContainer >::value &&traits::has_wide_elements< TContainer >::value >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements ( TContainer &  dest, std::size_t  size  )

inlineprotected

                                                          {
            using ValueType = typename TContainer::value_type;
            if (size != 0ul) {
                resize(dest, size);
                // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
                stream->read(reinterpret_cast<char*>(&dest[0]), size * sizeof(ValueType));
                const std::size_t blockWidth = 16ul / sizeof(ValueType);
                const std::size_t alignedSize = size - (size % blockWidth);
                for (std::size_t i = 0ul; i < alignedSize; i += blockWidth) {
                    SwapFrom<EByteOrder>::swap(&dest[i]);
                }
 
                for (std::size_t i = alignedSize; i < size; ++i) {
                    SwapFrom<EByteOrder>::swap(dest[i]);
                }
            }
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::resize(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream.

processElements() [4/4]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<class TContainer >

std::enable_if< traits::is_batchable< TContainer >::value &&!traits::has_wide_elements< TContainer >::value >::type terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements ( TContainer &  dest, std::size_t  size  )

inlineprotected

                                                          {
            using ValueType = typename TContainer::value_type;
            if (size != 0ul) {
                resize(dest, size);
                // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
                stream->read(reinterpret_cast<char*>(&dest[0]), size * sizeof(ValueType));
            }
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::resize(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream.

processSize()

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

std::size_t terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processSize ( )

inlineprotected

                                {
            SizeType size{};
            process(size);
            return static_cast<std::size_t>(size);
        }

References terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process().

Referenced by terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process().

resize() [1/2]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<typename T , class TAllocator >

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::resize ( DynArray< T, TAllocator > &  dest, std::size_t  size  )

inlineprivate

                                                                   {
            dest.resize_uninitialized(size);
        }

References terse::DynArray< T, TAllocator >::resize_uninitialized().

resize() [2/2]

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

template<class TContainer >

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::resize ( TContainer &  dest, std::size_t  size  )

inlineprivate

                                                      {
            dest.resize(size);
        }

Referenced by terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements().

sync()

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

void terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::sync ( )

inline

                    {
        }

Member Data Documentation

stream

template<class TExtender , class TStream , typename TSize , typename TOffset , Endianness EByteOrder>

TStream* terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::stream

private

Referenced by terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::process(), and terse::ExtendableBinaryInputArchive< TExtender, TStream, TSize, TOffset, EByteOrder >::processElements().

---

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

• binary/InputArchive.h