VLink  2.3.0
A high-performance communication middleware
someip_serializer.h 文件参考

SOME/IP payload codec helpers and template field traversal. 更多...

#include <array>
#include <cstddef>
#include <cstdint>
#include <limits>
#include <map>
#include <optional>
#include <string>
#include <tuple>
#include <type_traits>
#include <unordered_map>
#include <utility>
#include <variant>
#include <vector>
#include "../base/bytes.h"
#include "../base/macros.h"
#include "../base/traits.h"
someip_serializer.h 的引用(Include)关系图:

浏览源代码.

类

class  vlink::SomeipSerializer::Writer
 Bounds-checked SOME/IP payload writer. 更多...
 
class  vlink::SomeipSerializer::Reader
 Bounds-checked SOME/IP payload reader. 更多...
 
struct  vlink::SomeipSerializer::LengthField< LenT, T, MaxT >
 
struct  vlink::SomeipSerializer::ArrayLengthField< T, LenT, InnerLenT >
 
struct  vlink::SomeipSerializer::Utf16Field< LenT, EncodingT, T, MaxT >
 
struct  vlink::SomeipSerializer::FixedStringField< SizeT, LenT, EncodingT, T, MaxT >
 
struct  vlink::SomeipSerializer::UnionField< LenT, TypeT, T >
 
struct  vlink::SomeipSerializer::TlvField< DataIdT, LenT, DynamicT, T, MaxT >
 
struct  vlink::SomeipSerializer::TlvFixedStringField< DataIdT, LenT, DynamicT, SizeT, EncodingT, T, MaxT >
 
struct  vlink::SomeipSerializer::TlvArrayField< DataIdT, LenT, DynamicT, T, InnerLenT >
 

命名空间

 
 
 

宏定义

#define VLINK_SOMEIP_ALIGNMENT(alignment)    [[nodiscard]] static constexpr size_t vlink_someip_alignment() noexcept { return alignment; }
 Macro Definitions 更多...
 
#define VLINK_SOMEIP_ENDIAN(endian)    [[nodiscard]] static constexpr vlink::SomeipSerializer::Endian vlink_someip_endian() noexcept { return endian; }
 Selects the payload scalar byte order for a top-level structure; the default is Endian::kBig. 更多...
 
#define VLINK_SOMEIP_ENDIAN_BIG   VLINK_SOMEIP_ENDIAN(vlink::SomeipSerializer::Endian::kBig)
 Selects big-endian SOME/IP payload scalar values. 更多...
 
#define VLINK_SOMEIP_ENDIAN_LITTLE   VLINK_SOMEIP_ENDIAN(vlink::SomeipSerializer::Endian::kLittle)
 Selects little-endian SOME/IP payload scalar values. 更多...
 
#define VLINK_SOMEIP_STRUCT_LENGTH(width)    [[nodiscard]] static constexpr size_t vlink_someip_struct_length() noexcept { return width; }
 Selects the structure length field width: 0 (default, omitted), 1, 2, or 4 bytes; TLV structures must select a non-zero width. 更多...
 
#define VLINK_SOMEIP_LENGTH(field, width)   vlink::SomeipSerializer::length_field<width>(field)
 Wraps one UTF-8/UTF-16 string, Bytes, vector, or map field with a 1, 2, or 4-byte length width; a fixed array may also use zero to omit it. Unwrapped length-delimited fields use four bytes. 更多...
 
#define VLINK_SOMEIP_LENGTH_MAX(field, width, maximum)   vlink::SomeipSerializer::length_field<width, maximum>(field)
 Adds a maximum character, element, or byte count to a length-delimited field. 更多...
 
#define VLINK_SOMEIP_ARRAY_LENGTH(field, ...)   vlink::SomeipSerializer::array_length_field<__VA_ARGS__>(field)
 Wraps one nested array field with per-dimension length widths from outermost to innermost; unlisted dimensions keep four bytes and a nested structure keeps its own field configuration. 更多...
 
#define VLINK_SOMEIP_UTF16(field, width, endian)   vlink::SomeipSerializer::utf16_field<width, endian>(field)
 Wraps one std::u16string field with a 1, 2, or 4-byte length width and an explicit code unit byte order; unwrapped fields use four bytes and UTF-16BE. 更多...
 
#define VLINK_SOMEIP_UTF16_MAX(field, width, endian, maximum)    vlink::SomeipSerializer::utf16_field<width, endian, maximum>(field)
 Adds a maximum Unicode character count to an explicitly encoded UTF-16 field. 更多...
 
#define VLINK_SOMEIP_UTF16_BE(field, width)   VLINK_SOMEIP_UTF16(field, width, vlink::SomeipSerializer::Endian::kBig)
 Selects a UTF-16BE string field with a configurable length width. 更多...
 
#define VLINK_SOMEIP_UTF16_LE(field, width)   VLINK_SOMEIP_UTF16(field, width, vlink::SomeipSerializer::Endian::kLittle)
 Selects a UTF-16LE string field with a configurable length width. 更多...
 
#define VLINK_SOMEIP_FIXED_STRING(field, size, width)   vlink::SomeipSerializer::fixed_string_field<size, width>(field)
 Selects a fixed-size UTF-8 string; size includes BOM, content, terminator, and zero padding, while width may be 0, 1, 2, or 4. 更多...
 
#define VLINK_SOMEIP_FIXED_STRING_MAX(field, size, width, maximum)    vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kBig, maximum>(field)
 Adds a maximum Unicode character count to a fixed-size UTF-8 string. 更多...
 
#define VLINK_SOMEIP_FIXED_UTF16_BE(field, size, width)    vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kBig>(field)
 Selects a fixed-size UTF-16BE string using the specified total byte size and length width. 更多...
 
#define VLINK_SOMEIP_FIXED_UTF16_BE_MAX(field, size, width, maximum)    vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kBig, maximum>(field)
 Adds a maximum Unicode character count to a fixed-size UTF-16BE string. 更多...
 
#define VLINK_SOMEIP_FIXED_UTF16_LE(field, size, width)    vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kLittle>(field)
 Selects a fixed-size UTF-16LE string using the specified total byte size and length width. 更多...
 
#define VLINK_SOMEIP_FIXED_UTF16_LE_MAX(field, size, width, maximum)    vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kLittle, maximum>(field)
 Adds a maximum Unicode character count to a fixed-size UTF-16LE string. 更多...
 
#define VLINK_SOMEIP_UNION(field, length_width, type_width)    vlink::SomeipSerializer::union_field<length_width, type_width>(field)
 Wraps one std::variant field with 1, 2, or 4-byte length and type selector widths; the length excludes the selector, selectors count alternatives in declaration order from one. A first std::monostate explicitly enables selector zero. Unwrapped fields use four bytes. 更多...
 
#define VLINK_SOMEIP_TLV(data_id, field)   vlink::SomeipSerializer::tlv_field<data_id>(field)
 Declares one TLV member with its unique 12-bit data ID; every field of a TLV structure must be tagged and the structure must declare VLINK_SOMEIP_STRUCT_LENGTH. Complex members select a 1, 2, or 4-byte length from their actual size, absent std::optional members are omitted and reset on input, unknown data IDs are skipped, and a repeated known data ID rejects the input. Nested length-delimited values require their corresponding field macros. 更多...
 
#define VLINK_SOMEIP_TLV_LENGTH(data_id, field, width)   vlink::SomeipSerializer::tlv_field<data_id, width>(field)
 Declares one dynamically sized TLV member and configures the 1, 2, or 4-byte structure width used when receiving an unknown wire type 4; fixed-width members still declare this shared width but emit wire types 0–3. 更多...
 
#define VLINK_SOMEIP_TLV_LENGTH_MAX(data_id, field, width, maximum)    vlink::SomeipSerializer::tlv_field<data_id, width, true, maximum>(field)
 Adds a maximum character, element, or byte count to a dynamically sized TLV member. 更多...
 
#define VLINK_SOMEIP_TLV_FIXED_STRING(data_id, field, size, width, endian)    vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, true, size, endian>(field)
 Declares a dynamic TLV fixed string with a total byte size, structure width, and UTF-16 byte order. 更多...
 
#define VLINK_SOMEIP_TLV_FIXED_STRING_MAX(data_id, field, size, width, endian, maximum)    vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, true, size, endian, maximum>(field)
 Adds a maximum Unicode character count to a dynamic TLV fixed string. 更多...
 
#define VLINK_SOMEIP_TLV_ARRAY_LENGTH(data_id, field, width, ...)    vlink::SomeipSerializer::tlv_array_field<data_id, width, true, __VA_ARGS__>(field)
 Declares a multidimensional TLV array member whose inner dimensions inherit the structure-wide length width. 更多...
 
#define VLINK_SOMEIP_TLV_STATIC_LENGTH(data_id, field, width)    vlink::SomeipSerializer::tlv_field<data_id, width, false>(field)
 Declares one complex TLV member that emits wire type 4 with the configured 1, 2, or 4-byte static structure width; fixed-width members still declare this shared width but emit wire types 0–3. 更多...
 
#define VLINK_SOMEIP_TLV_STATIC_LENGTH_MAX(data_id, field, width, maximum)    vlink::SomeipSerializer::tlv_field<data_id, width, false, maximum>(field)
 Adds a maximum character, element, or byte count to a static-length TLV member. 更多...
 
#define VLINK_SOMEIP_TLV_STATIC_FIXED_STRING(data_id, field, size, width, endian)    vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, false, size, endian>(field)
 Declares a static TLV fixed string with a total byte size, structure width, and UTF-16 byte order. 更多...
 
#define VLINK_SOMEIP_TLV_STATIC_FIXED_STRING_MAX(data_id, field, size, width, endian, maximum)    vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, false, size, endian, maximum>(field)
 Adds a maximum Unicode character count to a static TLV fixed string. 更多...
 
#define VLINK_SOMEIP_TLV_STATIC_ARRAY_LENGTH(data_id, field, width, ...)    vlink::SomeipSerializer::tlv_array_field<data_id, width, false, __VA_ARGS__>(field)
 Declares a multidimensional static-length TLV array member whose inner dimensions inherit the structure-wide length width. 更多...
 
#define VLINK_SOMEIP_FIELDS(...)
 Declares a structure as a SOME/IP payload and lists its fields in wire-format order. 更多...
 

枚举

enum class  vlink::SomeipSerializer::Endian : uint8_t { vlink::SomeipSerializer::kBig = 0 , vlink::SomeipSerializer::kLittle = 1 }
 Byte order used for SOME/IP payload scalar values. 更多...
 

函数

template<typename T >
bool vlink::SomeipSerializer::write_value (Writer &writer, const T &value) noexcept
 Encodes an enum or macro-declared nested SOME/IP structure. 更多...
 
template<size_t MaxT = std::numeric_limits<size_t>::max(), typename T , typename AllocatorT , size_t... InnerLenT>
bool vlink::SomeipSerializer::write_value (Writer &writer, const std::vector< T, AllocatorT > &value, size_t len=sizeof(uint32_t), std::index_sequence< InnerLenT... >={}) noexcept
 Encodes a dynamic array with a configurable byte-length prefix. 更多...
 
template<typename T , size_t SizeT, size_t... InnerLenT>
bool vlink::SomeipSerializer::write_value (Writer &writer, const std::array< T, SizeT > &value, size_t len=sizeof(uint32_t), std::index_sequence< InnerLenT... >={}) noexcept
 Encodes a fixed-size array with an optional byte-length prefix. 更多...
 
template<typename... AlternativeT>
bool vlink::SomeipSerializer::write_value (Writer &writer, const std::variant< AlternativeT... > &value, size_t len=sizeof(uint32_t), size_t type_width=sizeof(uint32_t)) noexcept
 Encodes a union with a byte length and a type selector. 更多...
 
template<typename T >
bool vlink::SomeipSerializer::read_value (Reader &reader, T &value, size_t end) noexcept
 Decodes an enum or macro-declared nested SOME/IP structure. 更多...
 
template<size_t MaxT = std::numeric_limits<size_t>::max(), typename T , typename AllocatorT , size_t... InnerLenT>
bool vlink::SomeipSerializer::read_value (Reader &reader, std::vector< T, AllocatorT > &value, size_t end, size_t len=sizeof(uint32_t), std::index_sequence< InnerLenT... >={}) noexcept
 Decodes a byte-length-delimited dynamic array. 更多...
 
template<typename T , size_t SizeT, size_t... InnerLenT>
bool vlink::SomeipSerializer::read_value (Reader &reader, std::array< T, SizeT > &value, size_t end, size_t len=sizeof(uint32_t), std::index_sequence< InnerLenT... >={}) noexcept
 Decodes a byte-length-delimited fixed-size array. 更多...
 
template<typename... AlternativeT>
bool vlink::SomeipSerializer::read_value (Reader &reader, std::variant< AlternativeT... > &value, size_t end, size_t len=sizeof(uint32_t), size_t type_width=sizeof(uint32_t)) noexcept
 Decodes a union with a byte length and a type selector. 更多...
 
template<typename T >
size_t vlink::SomeipSerializer::get_serialized_size (const T &src) noexcept
 Returns the exact SOME/IP payload size for src. 更多...
 
template<typename T >
bool vlink::SomeipSerializer::serialize (const T &src, Bytes &des) noexcept
 Serializes src into des using the SOME/IP payload format. 更多...
 
template<typename T >
bool vlink::SomeipSerializer::serialize (const T &src, Bytes &des, uint8_t offset) noexcept
 Serializes src with reserved bytes before the payload. 更多...
 
template<typename T >
bool vlink::SomeipSerializer::deserialize (const Bytes &src, T &des) noexcept
 Deserializes a complete SOME/IP payload from src into des. 更多...
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_variable_size () noexcept
 Reports whether T encodes with a runtime-variable byte length. 更多...
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, bool value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, uint8_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, uint16_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, uint32_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, uint64_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, int8_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, int16_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, int32_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, int64_t value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, float value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, double value) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, const std::string &value, size_t len=sizeof(uint32_t), size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, const Bytes &value, size_t len=sizeof(uint32_t), size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value (Writer &writer, const std::u16string &value, size_t len=sizeof(uint32_t), Endian encoding=Endian::kBig, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_fixed_value (Writer &writer, const std::string &value, size_t size, size_t len, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_fixed_value (Writer &writer, const std::u16string &value, size_t size, size_t len, Endian encoding, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, bool &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, uint8_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, uint16_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, uint32_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, uint64_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, int8_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, int16_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, int32_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, int64_t &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, float &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, double &value, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, std::string &value, size_t end, size_t len=sizeof(uint32_t), size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, Bytes &value, size_t end, size_t len=sizeof(uint32_t), size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value (Reader &reader, std::u16string &value, size_t end, size_t len=sizeof(uint32_t), Endian encoding=Endian::kBig, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_fixed_value (Reader &reader, std::string &value, size_t end, size_t size, size_t len, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_fixed_value (Reader &reader, std::u16string &value, size_t end, size_t size, size_t len, Endian encoding, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value_body (Reader &reader, std::string &value, size_t end, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value_body (Reader &reader, std::u16string &value, size_t end, Endian encoding=Endian::kBig, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_value_body (Reader &reader, Bytes &value, size_t end, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_tag (Reader &reader, uint8_t &wire_type, uint16_t &data_id, size_t end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::read_union_frame (Reader &reader, size_t len, size_t type_width, size_t end, uint64_t &selector, size_t &data_end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value_body (Writer &writer, const std::string &value, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value_body (Writer &writer, const std::u16string &value, Endian encoding=Endian::kBig, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_value_body (Writer &writer, const Bytes &value, size_t maximum=std::numeric_limits< size_t >::max()) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_tag (Writer &writer, uint8_t wire_type, uint16_t data_id) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::write_union_frame (Writer &writer, uint64_t selector, size_t len, size_t type_width, size_t &length_position, size_t &content_position) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::begin_tlv_body (Reader &reader, uint8_t wire_type, size_t configured_len, size_t end, size_t &body_end) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::begin_tlv_complex (Writer &writer, uint16_t data_id, size_t len, bool dynamic, size_t &length_position, size_t &data_position) noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::skip_tlv_value (Reader &reader, uint8_t wire_type, size_t configured_len, size_t end) noexcept
 
VLINK_EXPORT void vlink::SomeipSerializer::detail::report_check_available_failure () noexcept
 
VLINK_EXPORT bool vlink::SomeipSerializer::detail::prepare_destination (Bytes &des, size_t size, uint8_t offset) noexcept
 
template<typename T >
bool vlink::SomeipSerializer::read_value_body (Reader &reader, T &value, size_t end) noexcept
 
template<typename T >
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const T &value) noexcept
 
template<typename T >
constexpr size_t vlink::SomeipSerializer::get_alignment () noexcept
 
template<typename T >
constexpr Endian vlink::SomeipSerializer::get_endian () noexcept
 
template<typename T >
constexpr size_t vlink::SomeipSerializer::get_struct_length () noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_map (const T *) noexcept
 
template<typename KeyT , typename ValueT , typename CompareT , typename AllocatorT >
constexpr bool vlink::SomeipSerializer::is_map (const std::map< KeyT, ValueT, CompareT, AllocatorT > *) noexcept
 
template<typename KeyT , typename ValueT , typename HashT , typename EqualT , typename AllocatorT >
constexpr bool vlink::SomeipSerializer::is_map (const std::unordered_map< KeyT, ValueT, HashT, EqualT, AllocatorT > *) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_vector (const T *) noexcept
 
template<typename T , typename AllocatorT >
constexpr bool vlink::SomeipSerializer::is_vector (const std::vector< T, AllocatorT > *) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_variant (const T *) noexcept
 
template<typename... AlternativeT>
constexpr bool vlink::SomeipSerializer::is_variant (const std::variant< AlternativeT... > *) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_optional (const T *) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_optional (const std::optional< T > *) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::supports_maximum (const T *) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::supports_maximum (const std::optional< T > *) noexcept
 
template<typename T >
constexpr uint8_t vlink::SomeipSerializer::get_fixed_wire_type () noexcept
 
template<typename... AlternativeT>
constexpr bool vlink::SomeipSerializer::validate_union_alternatives () noexcept
 
template<typename FirstT , typename... AlternativeT>
constexpr bool vlink::SomeipSerializer::union_alternatives_have_equal_size (const std::variant< FirstT, AlternativeT... > *) noexcept
 
template<typename... AlternativeT>
constexpr bool vlink::SomeipSerializer::has_null_union_alternative () noexcept
 
template<size_t LenT, typename T >
constexpr bool vlink::SomeipSerializer::supports_length_field (const T *) noexcept
 
template<size_t LenT, typename T , typename AllocatorT >
constexpr bool vlink::SomeipSerializer::supports_length_field (const std::vector< T, AllocatorT > *) noexcept
 
template<size_t LenT, typename T , size_t SizeT>
constexpr bool vlink::SomeipSerializer::supports_length_field (const std::array< T, SizeT > *) noexcept
 
template<typename... FieldT>
auto vlink::SomeipSerializer::make_fields (FieldT &&... field) noexcept
 
template<size_t LenT, size_t MaxT = std::numeric_limits<size_t>::max(), typename T >
auto vlink::SomeipSerializer::length_field (T &value) noexcept
 
template<size_t LenT, size_t... InnerLenT, typename T >
auto vlink::SomeipSerializer::array_length_field (T &value) noexcept
 
template<size_t LenT, Endian EncodingT, size_t MaxT = std::numeric_limits<size_t>::max(), typename T >
auto vlink::SomeipSerializer::utf16_field (T &value) noexcept
 
template<size_t SizeT, size_t LenT, Endian EncodingT = Endian::kBig, size_t MaxT = std::numeric_limits<size_t>::max(), typename T >
auto vlink::SomeipSerializer::fixed_string_field (T &value) noexcept
 
template<size_t LenT, size_t TypeT, typename T >
auto vlink::SomeipSerializer::union_field (T &value) noexcept
 
template<uint16_t DataIdT, size_t LenT = sizeof(uint32_t), bool DynamicT = true, size_t MaxT = std::numeric_limits<size_t>::max(), typename T >
auto vlink::SomeipSerializer::tlv_field (T &value) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, size_t SizeT, Endian EncodingT, size_t MaxT = std::numeric_limits<size_t>::max(), typename T >
auto vlink::SomeipSerializer::tlv_fixed_string_field (T &value) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, size_t... InnerLenT, typename T >
auto vlink::SomeipSerializer::tlv_array_field (T &value) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_tlv_field (const T *) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, typename T , size_t MaxT>
constexpr bool vlink::SomeipSerializer::is_tlv_field (const TlvField< DataIdT, LenT, DynamicT, T, MaxT > *) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, size_t SizeT, Endian EncodingT, typename T , size_t MaxT>
constexpr bool vlink::SomeipSerializer::is_tlv_field (const TlvFixedStringField< DataIdT, LenT, DynamicT, SizeT, EncodingT, T, MaxT > *) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, typename T , size_t... InnerLenT>
constexpr bool vlink::SomeipSerializer::is_tlv_field (const TlvArrayField< DataIdT, LenT, DynamicT, T, InnerLenT... > *) noexcept
 
template<typename TupleT , size_t... IndexT>
constexpr size_t vlink::SomeipSerializer::count_tlv_fields (std::index_sequence< IndexT... >) noexcept
 
template<typename TupleT , size_t... IndexT>
constexpr bool vlink::SomeipSerializer::tlv_data_ids_are_unique (std::index_sequence< IndexT... >) noexcept
 
template<size_t LenT, typename TupleT , size_t... IndexT>
constexpr bool vlink::SomeipSerializer::tlv_length_widths_are_equal (std::index_sequence< IndexT... >) noexcept
 
template<typename TupleT , size_t... IndexT>
constexpr bool vlink::SomeipSerializer::fields_are_variable (std::index_sequence< IndexT... >) noexcept
 
template<typename T , typename AllocatorT >
constexpr bool vlink::SomeipSerializer::is_variable_size (const std::vector< T, AllocatorT > *) noexcept
 
template<typename T , size_t SizeT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const std::array< T, SizeT > *) noexcept
 
template<size_t LenT, typename T , size_t MaxT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const LengthField< LenT, T, MaxT > *) noexcept
 
template<typename T , size_t LenT, size_t... InnerLenT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const ArrayLengthField< T, LenT, InnerLenT... > *) noexcept
 
template<typename KeyT , typename ValueT , typename CompareT , typename AllocatorT >
constexpr bool vlink::SomeipSerializer::is_variable_size (const std::map< KeyT, ValueT, CompareT, AllocatorT > *) noexcept
 
template<typename KeyT , typename ValueT , typename HashT , typename EqualT , typename AllocatorT >
constexpr bool vlink::SomeipSerializer::is_variable_size (const std::unordered_map< KeyT, ValueT, HashT, EqualT, AllocatorT > *) noexcept
 
template<typename... AlternativeT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const std::variant< AlternativeT... > *) noexcept
 
template<size_t LenT, Endian EncodingT, typename T , size_t MaxT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const Utf16Field< LenT, EncodingT, T, MaxT > *) noexcept
 
template<size_t SizeT, size_t LenT, Endian EncodingT, typename T , size_t MaxT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const FixedStringField< SizeT, LenT, EncodingT, T, MaxT > *) noexcept
 
template<size_t LenT, size_t TypeT, typename T >
constexpr bool vlink::SomeipSerializer::is_variable_size (const UnionField< LenT, TypeT, T > *) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, typename T , size_t MaxT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const TlvField< DataIdT, LenT, DynamicT, T, MaxT > *) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, size_t SizeT, Endian EncodingT, typename T , size_t MaxT>
constexpr bool vlink::SomeipSerializer::is_variable_size (const TlvFixedStringField< DataIdT, LenT, DynamicT, SizeT, EncodingT, T, MaxT > *) noexcept
 
template<typename T >
constexpr bool vlink::SomeipSerializer::is_variable_size (const T *) noexcept
 
template<size_t LenT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::read_value (Reader &reader, LengthField< LenT, T, MaxT > &field, size_t end) noexcept
 
template<typename T , size_t LenT, size_t... InnerLenT>
bool vlink::SomeipSerializer::read_value (Reader &reader, ArrayLengthField< T, LenT, InnerLenT... > &field, size_t end) noexcept
 
template<size_t LenT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::read_value (Reader &reader, Utf16Field< LenT, EncodingT, T, MaxT > &field, size_t end) noexcept
 
template<size_t SizeT, size_t LenT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::read_value (Reader &reader, FixedStringField< SizeT, LenT, EncodingT, T, MaxT > &field, size_t end) noexcept
 
template<size_t SizeT, size_t LenT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::read_value_body (Reader &reader, FixedStringField< SizeT, LenT, EncodingT, T, MaxT > &field, size_t end) noexcept
 
template<size_t LenT, size_t TypeT, typename T >
bool vlink::SomeipSerializer::read_value (Reader &reader, UnionField< LenT, TypeT, T > &field, size_t end) noexcept
 
template<typename TupleT , size_t... IndexT>
bool vlink::SomeipSerializer::read_fields (Reader &reader, TupleT &fields, size_t end, std::index_sequence< IndexT... >) noexcept
 
template<size_t MaxT = std::numeric_limits<size_t>::max(), typename T , typename AllocatorT , size_t... InnerLenT>
bool vlink::SomeipSerializer::read_value_body (Reader &reader, std::vector< T, AllocatorT > &value, size_t end, std::index_sequence< InnerLenT... >={}) noexcept
 
template<typename T , size_t SizeT, size_t... InnerLenT>
bool vlink::SomeipSerializer::read_value_body (Reader &reader, std::array< T, SizeT > &value, size_t end, std::index_sequence< InnerLenT... >={}) noexcept
 
template<typename KeyT , typename ValueT , typename CompareT , typename AllocatorT >
bool vlink::SomeipSerializer::read_value_body (Reader &reader, std::map< KeyT, ValueT, CompareT, AllocatorT > &value, size_t end) noexcept
 
template<typename KeyT , typename ValueT , typename HashT , typename EqualT , typename AllocatorT >
bool vlink::SomeipSerializer::read_value_body (Reader &reader, std::unordered_map< KeyT, ValueT, HashT, EqualT, AllocatorT > &value, size_t end) noexcept
 
template<typename T , size_t LenT, size_t... InnerLenT>
bool vlink::SomeipSerializer::read_value_body (Reader &reader, ArrayLengthField< T, LenT, InnerLenT... > &field, size_t end) noexcept
 
template<typename... AlternativeT>
bool vlink::SomeipSerializer::read_value_body (Reader &reader, std::variant< AlternativeT... > &value, size_t end) noexcept
 
template<typename MapT >
bool vlink::SomeipSerializer::read_map_entries (Reader &reader, MapT &value, size_t end) noexcept
 
template<size_t IndexT, typename... AlternativeT>
bool vlink::SomeipSerializer::read_union_element (Reader &reader, std::variant< AlternativeT... > &value, size_t data_end) noexcept
 
template<typename... AlternativeT, size_t... IndexT>
bool vlink::SomeipSerializer::read_union_alternative (Reader &reader, std::variant< AlternativeT... > &value, uint64_t selector, size_t data_end, std::index_sequence< IndexT... >) noexcept
 
template<size_t LenT, size_t MaxT = std::numeric_limits<size_t>::max(), typename T >
bool vlink::SomeipSerializer::read_tlv_value (Reader &reader, T &value, uint8_t wire_type, size_t end) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::read_tlv_field (Reader &reader, TlvField< DataIdT, LenT, DynamicT, T, MaxT > &field, uint8_t wire_type, size_t end) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, size_t SizeT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::read_tlv_field (Reader &reader, TlvFixedStringField< DataIdT, LenT, DynamicT, SizeT, EncodingT, T, MaxT > &field, uint8_t wire_type, size_t end) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, typename T , size_t... InnerLenT>
bool vlink::SomeipSerializer::read_tlv_field (Reader &reader, TlvArrayField< DataIdT, LenT, DynamicT, T, InnerLenT... > &field, uint8_t wire_type, size_t end) noexcept
 
template<typename T >
bool vlink::SomeipSerializer::finish_missing_tlv_value (T &value) noexcept
 
template<size_t LenT, typename TupleT , size_t... IndexT>
bool vlink::SomeipSerializer::read_tlv_fields (Reader &reader, TupleT &fields, size_t end, std::index_sequence< IndexT... >) noexcept
 
template<size_t LenT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::write_value (Writer &writer, const LengthField< LenT, T, MaxT > &field) noexcept
 
template<typename T , size_t LenT, size_t... InnerLenT>
bool vlink::SomeipSerializer::write_value (Writer &writer, const ArrayLengthField< T, LenT, InnerLenT... > &field) noexcept
 
template<size_t LenT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::write_value (Writer &writer, const Utf16Field< LenT, EncodingT, T, MaxT > &field) noexcept
 
template<size_t SizeT, size_t LenT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::write_value (Writer &writer, const FixedStringField< SizeT, LenT, EncodingT, T, MaxT > &field) noexcept
 
template<size_t SizeT, size_t LenT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const FixedStringField< SizeT, LenT, EncodingT, T, MaxT > &field) noexcept
 
template<size_t LenT, size_t TypeT, typename T >
bool vlink::SomeipSerializer::write_value (Writer &writer, const UnionField< LenT, TypeT, T > &field) noexcept
 
template<typename TupleT , size_t... IndexT>
bool vlink::SomeipSerializer::write_fields (Writer &writer, const TupleT &fields, std::index_sequence< IndexT... >) noexcept
 
template<typename T , typename AllocatorT , size_t... InnerLenT>
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const std::vector< T, AllocatorT > &value, std::index_sequence< InnerLenT... >={}) noexcept
 
template<typename T , size_t SizeT, size_t... InnerLenT>
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const std::array< T, SizeT > &value, std::index_sequence< InnerLenT... >={}) noexcept
 
template<typename KeyT , typename ValueT , typename CompareT , typename AllocatorT >
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const std::map< KeyT, ValueT, CompareT, AllocatorT > &value) noexcept
 
template<typename KeyT , typename ValueT , typename HashT , typename EqualT , typename AllocatorT >
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const std::unordered_map< KeyT, ValueT, HashT, EqualT, AllocatorT > &value) noexcept
 
template<typename T , size_t LenT, size_t... InnerLenT>
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const ArrayLengthField< T, LenT, InnerLenT... > &field) noexcept
 
template<typename... AlternativeT>
bool vlink::SomeipSerializer::write_value_body (Writer &writer, const std::variant< AlternativeT... > &value) noexcept
 
template<typename MapT >
bool vlink::SomeipSerializer::write_map_entries (Writer &writer, const MapT &value) noexcept
 
template<size_t IndexT, typename... AlternativeT>
bool vlink::SomeipSerializer::write_union_element (Writer &writer, const std::variant< AlternativeT... > &value) noexcept
 
template<typename... AlternativeT, size_t... IndexT>
bool vlink::SomeipSerializer::write_union_alternative (Writer &writer, const std::variant< AlternativeT... > &value, std::index_sequence< IndexT... >) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, size_t MaxT = std::numeric_limits<size_t>::max(), typename T >
bool vlink::SomeipSerializer::write_tlv_value (Writer &writer, const T &value) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::write_tlv_field (Writer &writer, const TlvField< DataIdT, LenT, DynamicT, T, MaxT > &field) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, size_t SizeT, Endian EncodingT, typename T , size_t MaxT>
bool vlink::SomeipSerializer::write_tlv_field (Writer &writer, const TlvFixedStringField< DataIdT, LenT, DynamicT, SizeT, EncodingT, T, MaxT > &field) noexcept
 
template<uint16_t DataIdT, size_t LenT, bool DynamicT, typename T , size_t... InnerLenT>
bool vlink::SomeipSerializer::write_tlv_field (Writer &writer, const TlvArrayField< DataIdT, LenT, DynamicT, T, InnerLenT... > &field) noexcept
 
template<typename TupleT , size_t... IndexT>
bool vlink::SomeipSerializer::write_tlv_fields (Writer &writer, const TupleT &fields, std::index_sequence< IndexT... >) noexcept
 
template<typename KeyT , typename ValueT , typename CompareT , typename AllocatorT >
bool vlink::SomeipSerializer::write_value (Writer &writer, const std::map< KeyT, ValueT, CompareT, AllocatorT > &value, size_t len=sizeof(uint32_t)) noexcept
 Encodes an associative map with a configurable byte-length prefix. 更多...
 
template<typename KeyT , typename ValueT , typename HashT , typename EqualT , typename AllocatorT >
bool vlink::SomeipSerializer::write_value (Writer &writer, const std::unordered_map< KeyT, ValueT, HashT, EqualT, AllocatorT > &value, size_t len=sizeof(uint32_t)) noexcept
 
template<typename KeyT , typename ValueT , typename CompareT , typename AllocatorT >
bool vlink::SomeipSerializer::read_value (Reader &reader, std::map< KeyT, ValueT, CompareT, AllocatorT > &value, size_t end, size_t len=sizeof(uint32_t)) noexcept
 Decodes a byte-length-delimited associative map. 更多...
 
template<typename KeyT , typename ValueT , typename HashT , typename EqualT , typename AllocatorT >
bool vlink::SomeipSerializer::read_value (Reader &reader, std::unordered_map< KeyT, ValueT, HashT, EqualT, AllocatorT > &value, size_t end, size_t len=sizeof(uint32_t)) noexcept
 

详细描述

SOME/IP payload codec helpers and template field traversal.

Implements the AUTOSAR R25-11 payload deployment selected by VLINK_SOMEIP_FIELDS: configurable payload byte order, alignment from the SOME/IP message start, field and structure length widths, UTF-8 and UTF-16 strings framed by a BOM and null terminator, associative maps, unions with a type selector, and TLV structures with optional members and self-describing unknown-member skipping. Length fields, TLV tags, and union type selectors keep network byte order. The SOME/IP message header is outside this codec and limits a payload to UINT32_MAX-8 bytes.

Non-template cursor and primitive operations are implemented once in src/extension/someip_serializer.cc; only container traversal and structure expansion remain templates. Failures are reported through boolean return values, and unsupported field types are rejected at compile time. Mixed or opaque field byte order and C++ bit-fields are not supported; deployment maximum-length constraints may be declared by the corresponding field wrappers; the wire format details are documented in doc/03-serialization.md.

宏定义说明

◆ VLINK_SOMEIP_ALIGNMENT

#define VLINK_SOMEIP_ALIGNMENT (   alignment)     [[nodiscard]] static constexpr size_t vlink_someip_alignment() noexcept { return alignment; }

Macro Definitions

Selects the AUTOSAR alignment (1, 2, 4, 8, 16, or 32 bytes) for a top-level payload structure; the default is one byte.

◆ VLINK_SOMEIP_ARRAY_LENGTH

#define VLINK_SOMEIP_ARRAY_LENGTH (   field,
  ... 
)    vlink::SomeipSerializer::array_length_field<__VA_ARGS__>(field)

Wraps one nested array field with per-dimension length widths from outermost to innermost; unlisted dimensions keep four bytes and a nested structure keeps its own field configuration.

◆ VLINK_SOMEIP_ENDIAN

#define VLINK_SOMEIP_ENDIAN (   endian)     [[nodiscard]] static constexpr vlink::SomeipSerializer::Endian vlink_someip_endian() noexcept { return endian; }

Selects the payload scalar byte order for a top-level structure; the default is Endian::kBig.

◆ VLINK_SOMEIP_ENDIAN_BIG

#define VLINK_SOMEIP_ENDIAN_BIG   VLINK_SOMEIP_ENDIAN(vlink::SomeipSerializer::Endian::kBig)

Selects big-endian SOME/IP payload scalar values.

◆ VLINK_SOMEIP_ENDIAN_LITTLE

#define VLINK_SOMEIP_ENDIAN_LITTLE   VLINK_SOMEIP_ENDIAN(vlink::SomeipSerializer::Endian::kLittle)

Selects little-endian SOME/IP payload scalar values.

◆ VLINK_SOMEIP_FIELDS

#define VLINK_SOMEIP_FIELDS (   ...)
值:
[[nodiscard]] static constexpr bool is_vlink_someip_type() noexcept { return true; } \
\
[[nodiscard]] auto get_vlink_someip_fields() noexcept { return vlink::SomeipSerializer::make_fields(__VA_ARGS__); } \
\
[[nodiscard]] auto get_vlink_someip_fields() const noexcept { \
return vlink::SomeipSerializer::make_fields(__VA_ARGS__); \
} \
\
[[nodiscard]] size_t get_serialized_size() const noexcept { \
} \
\
bool serialize(vlink::Bytes& out, uint8_t offset = 0U) const noexcept { \
return vlink::SomeipSerializer::serialize(*this, out, offset); \
} \
\
bool deserialize(const vlink::Bytes& in) noexcept { return vlink::SomeipSerializer::deserialize(in, *this); } \
\
bool operator>>(vlink::Bytes& out) const noexcept { return serialize(out); } \
\
bool operator<<(const vlink::Bytes& in) noexcept { return deserialize(in); }

Declares a structure as a SOME/IP payload and lists its fields in wire-format order.

Generates the SOME/IP marker, ordered field access, an exact-size query, a serialize() member with an explicit offset parameter, a deserialize() member that reads the Bytes payload region, and the vlink::Bytes stream operators. Fields may be fixed-width numeric values, unsigned fixed-width enums, std::string, std::u16string, Bytes, std::vector, std::array, std::map, std::unordered_map, std::variant, nested structures using the same macro, or TLV members declared with VLINK_SOMEIP_TLV. At least one field must be listed, and buffers passed to the generated operators must not overlap storage reachable from the structure.

◆ VLINK_SOMEIP_FIXED_STRING

#define VLINK_SOMEIP_FIXED_STRING (   field,
  size,
  width 
)    vlink::SomeipSerializer::fixed_string_field<size, width>(field)

Selects a fixed-size UTF-8 string; size includes BOM, content, terminator, and zero padding, while width may be 0, 1, 2, or 4.

◆ VLINK_SOMEIP_FIXED_STRING_MAX

#define VLINK_SOMEIP_FIXED_STRING_MAX (   field,
  size,
  width,
  maximum 
)     vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kBig, maximum>(field)

Adds a maximum Unicode character count to a fixed-size UTF-8 string.

◆ VLINK_SOMEIP_FIXED_UTF16_BE

#define VLINK_SOMEIP_FIXED_UTF16_BE (   field,
  size,
  width 
)     vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kBig>(field)

Selects a fixed-size UTF-16BE string using the specified total byte size and length width.

◆ VLINK_SOMEIP_FIXED_UTF16_BE_MAX

#define VLINK_SOMEIP_FIXED_UTF16_BE_MAX (   field,
  size,
  width,
  maximum 
)     vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kBig, maximum>(field)

Adds a maximum Unicode character count to a fixed-size UTF-16BE string.

◆ VLINK_SOMEIP_FIXED_UTF16_LE

#define VLINK_SOMEIP_FIXED_UTF16_LE (   field,
  size,
  width 
)     vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kLittle>(field)

Selects a fixed-size UTF-16LE string using the specified total byte size and length width.

◆ VLINK_SOMEIP_FIXED_UTF16_LE_MAX

#define VLINK_SOMEIP_FIXED_UTF16_LE_MAX (   field,
  size,
  width,
  maximum 
)     vlink::SomeipSerializer::fixed_string_field<size, width, vlink::SomeipSerializer::Endian::kLittle, maximum>(field)

Adds a maximum Unicode character count to a fixed-size UTF-16LE string.

◆ VLINK_SOMEIP_LENGTH

#define VLINK_SOMEIP_LENGTH (   field,
  width 
)    vlink::SomeipSerializer::length_field<width>(field)

Wraps one UTF-8/UTF-16 string, Bytes, vector, or map field with a 1, 2, or 4-byte length width; a fixed array may also use zero to omit it. Unwrapped length-delimited fields use four bytes.

◆ VLINK_SOMEIP_LENGTH_MAX

#define VLINK_SOMEIP_LENGTH_MAX (   field,
  width,
  maximum 
)    vlink::SomeipSerializer::length_field<width, maximum>(field)

Adds a maximum character, element, or byte count to a length-delimited field.

◆ VLINK_SOMEIP_STRUCT_LENGTH

#define VLINK_SOMEIP_STRUCT_LENGTH (   width)     [[nodiscard]] static constexpr size_t vlink_someip_struct_length() noexcept { return width; }

Selects the structure length field width: 0 (default, omitted), 1, 2, or 4 bytes; TLV structures must select a non-zero width.

◆ VLINK_SOMEIP_TLV

#define VLINK_SOMEIP_TLV (   data_id,
  field 
)    vlink::SomeipSerializer::tlv_field<data_id>(field)

Declares one TLV member with its unique 12-bit data ID; every field of a TLV structure must be tagged and the structure must declare VLINK_SOMEIP_STRUCT_LENGTH. Complex members select a 1, 2, or 4-byte length from their actual size, absent std::optional members are omitted and reset on input, unknown data IDs are skipped, and a repeated known data ID rejects the input. Nested length-delimited values require their corresponding field macros.

◆ VLINK_SOMEIP_TLV_ARRAY_LENGTH

#define VLINK_SOMEIP_TLV_ARRAY_LENGTH (   data_id,
  field,
  width,
  ... 
)     vlink::SomeipSerializer::tlv_array_field<data_id, width, true, __VA_ARGS__>(field)

Declares a multidimensional TLV array member whose inner dimensions inherit the structure-wide length width.

◆ VLINK_SOMEIP_TLV_FIXED_STRING

#define VLINK_SOMEIP_TLV_FIXED_STRING (   data_id,
  field,
  size,
  width,
  endian 
)     vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, true, size, endian>(field)

Declares a dynamic TLV fixed string with a total byte size, structure width, and UTF-16 byte order.

◆ VLINK_SOMEIP_TLV_FIXED_STRING_MAX

#define VLINK_SOMEIP_TLV_FIXED_STRING_MAX (   data_id,
  field,
  size,
  width,
  endian,
  maximum 
)     vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, true, size, endian, maximum>(field)

Adds a maximum Unicode character count to a dynamic TLV fixed string.

◆ VLINK_SOMEIP_TLV_LENGTH

#define VLINK_SOMEIP_TLV_LENGTH (   data_id,
  field,
  width 
)    vlink::SomeipSerializer::tlv_field<data_id, width>(field)

Declares one dynamically sized TLV member and configures the 1, 2, or 4-byte structure width used when receiving an unknown wire type 4; fixed-width members still declare this shared width but emit wire types 0–3.

◆ VLINK_SOMEIP_TLV_LENGTH_MAX

#define VLINK_SOMEIP_TLV_LENGTH_MAX (   data_id,
  field,
  width,
  maximum 
)     vlink::SomeipSerializer::tlv_field<data_id, width, true, maximum>(field)

Adds a maximum character, element, or byte count to a dynamically sized TLV member.

◆ VLINK_SOMEIP_TLV_STATIC_ARRAY_LENGTH

#define VLINK_SOMEIP_TLV_STATIC_ARRAY_LENGTH (   data_id,
  field,
  width,
  ... 
)     vlink::SomeipSerializer::tlv_array_field<data_id, width, false, __VA_ARGS__>(field)

Declares a multidimensional static-length TLV array member whose inner dimensions inherit the structure-wide length width.

◆ VLINK_SOMEIP_TLV_STATIC_FIXED_STRING

#define VLINK_SOMEIP_TLV_STATIC_FIXED_STRING (   data_id,
  field,
  size,
  width,
  endian 
)     vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, false, size, endian>(field)

Declares a static TLV fixed string with a total byte size, structure width, and UTF-16 byte order.

◆ VLINK_SOMEIP_TLV_STATIC_FIXED_STRING_MAX

#define VLINK_SOMEIP_TLV_STATIC_FIXED_STRING_MAX (   data_id,
  field,
  size,
  width,
  endian,
  maximum 
)     vlink::SomeipSerializer::tlv_fixed_string_field<data_id, width, false, size, endian, maximum>(field)

Adds a maximum Unicode character count to a static TLV fixed string.

◆ VLINK_SOMEIP_TLV_STATIC_LENGTH

#define VLINK_SOMEIP_TLV_STATIC_LENGTH (   data_id,
  field,
  width 
)     vlink::SomeipSerializer::tlv_field<data_id, width, false>(field)

Declares one complex TLV member that emits wire type 4 with the configured 1, 2, or 4-byte static structure width; fixed-width members still declare this shared width but emit wire types 0–3.

◆ VLINK_SOMEIP_TLV_STATIC_LENGTH_MAX

#define VLINK_SOMEIP_TLV_STATIC_LENGTH_MAX (   data_id,
  field,
  width,
  maximum 
)     vlink::SomeipSerializer::tlv_field<data_id, width, false, maximum>(field)

Adds a maximum character, element, or byte count to a static-length TLV member.

◆ VLINK_SOMEIP_UNION

#define VLINK_SOMEIP_UNION (   field,
  length_width,
  type_width 
)     vlink::SomeipSerializer::union_field<length_width, type_width>(field)

Wraps one std::variant field with 1, 2, or 4-byte length and type selector widths; the length excludes the selector, selectors count alternatives in declaration order from one. A first std::monostate explicitly enables selector zero. Unwrapped fields use four bytes.

◆ VLINK_SOMEIP_UTF16

#define VLINK_SOMEIP_UTF16 (   field,
  width,
  endian 
)    vlink::SomeipSerializer::utf16_field<width, endian>(field)

Wraps one std::u16string field with a 1, 2, or 4-byte length width and an explicit code unit byte order; unwrapped fields use four bytes and UTF-16BE.

◆ VLINK_SOMEIP_UTF16_BE

#define VLINK_SOMEIP_UTF16_BE (   field,
  width 
)    VLINK_SOMEIP_UTF16(field, width, vlink::SomeipSerializer::Endian::kBig)

Selects a UTF-16BE string field with a configurable length width.

◆ VLINK_SOMEIP_UTF16_LE

#define VLINK_SOMEIP_UTF16_LE (   field,
  width 
)    VLINK_SOMEIP_UTF16(field, width, vlink::SomeipSerializer::Endian::kLittle)

Selects a UTF-16LE string field with a configurable length width.

◆ VLINK_SOMEIP_UTF16_MAX

#define VLINK_SOMEIP_UTF16_MAX (   field,
  width,
  endian,
  maximum 
)     vlink::SomeipSerializer::utf16_field<width, endian, maximum>(field)

Adds a maximum Unicode character count to an explicitly encoded UTF-16 field.