comms::option::def::SequenceSizeFieldPrefix< TField > Struct Template Reference

#include "comms/options.h"

Detailed Description

template<typename TField>
struct comms::option::def::SequenceSizeFieldPrefix< TField >

Option that modifies the default behaviour of collection fields to prepend the serialised data with number of elements information.

Quite often when collection of fields is serialised it must be prepended with one or more bytes indicating number of elements that will follow. Applicable to fields that represent collection of raw data or other fields, such as comms::field::ArrayList or comms::field::String.
For example sequence of raw bytes must be prefixed with 2 bytes stating the size of the sequence:

using MyFieldBase = comms::Field<comms::option::def::BigEndian>;
using MyField =
    comms::field::ArrayList<
        MyFieldBase,
        std::uint8_t,
        comms::option::def::SequenceSizeFieldPrefix<
            comms::field::IntValue<MyFieldBase, std::uint16_t>
        >
    >;

Template Parameters

TField

Type of the field that represents size

---

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

• include/comms/options.h