pixie::SerializationBase< Derived > Class Template Reference

CRTP facade for optional binary serialization and deserialization. More...

#include <serialization.h>

Inheritance diagram for pixie::SerializationBase< Derived >:

Public Member Functions
void	serialize (BinaryWriter &writer) const
	Serialize this value through its concrete implementation.

Static Public Member Functions
template<class... Context> requires requires(BinaryReader& input, Context&&... arguments) { { Derived::deserialize_impl(input, std::forward<Context>(arguments)...) } -> std::same_as<Derived>; }
static Derived	deserialize (BinaryReader &reader, Context &&... context)
	Restore exactly Derived and advance reader on success.
template<class... Context> requires requires(BinaryReader& input, Context&&... arguments) { { Derived::deserialize_impl(input, std::forward<Context>(arguments)...) } -> std::same_as<Derived>; }
static Derived	deserialize (std::span< const std::byte > &data, Context &&... context)
	Restore exactly Derived and advance a mutable byte span.

Detailed Description

template<class Derived>
class pixie::SerializationBase< Derived >

CRTP facade for optional binary serialization and deserialization.

A derived type opts into serialization by providing serialize_impl(BinaryWriter&) const, and opts into restoration for a context by providing a static deserialize_impl(BinaryReader&, context...) returning exactly the derived type. Deserialization is transactional: the caller's cursor (or mutable input span) advances only after the complete implementation succeeds.

Template Parameters

Derived

Concrete serializable type.

Member Function Documentation

deserialize() [1/2]

template<class Derived>

template<class... Context>
requires requires(BinaryReader& input, Context&&... arguments) { { Derived::deserialize_impl(input, std::forward<Context>(arguments)...) } -> std::same_as<Derived>; }

static Derived pixie::SerializationBase< Derived >::deserialize ( BinaryReader & reader, Context &&... context )

inlinestatic

Restore exactly Derived and advance reader on success.

Any contextual arguments follow the reader. The reader is unchanged if parsing, allocation, or validation throws.

deserialize() [2/2]

template<class Derived>

template<class... Context>
requires requires(BinaryReader& input, Context&&... arguments) { { Derived::deserialize_impl(input, std::forward<Context>(arguments)...) } -> std::same_as<Derived>; }

static Derived pixie::SerializationBase< Derived >::deserialize ( std::span< const std::byte > & data, Context &&... context )

inlinestatic

Restore exactly Derived and advance a mutable byte span.

This shared convenience overload has the same transactional behavior as the BinaryReader overload.

---

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

• include/pixie/serialization.h