vlink::zerocopy::MessageParser::Field Struct Reference

Schema-neutral field descriptor returned by field enumeration. More...

#include <message_parser.h>

Collaboration diagram for vlink::zerocopy::MessageParser::Field:

Public Attributes
std::string	name
	Canonical path or collection element field name. More...
ValueType	type {ValueType::kValueUnknown}
	Exact Value alternative returned for the field. More...
uint16_t	native_type {0}
	Message-specific schema type tag, or zero when not applicable. More...
uint16_t	storage_size {0}
	Encoded field width in bytes, or zero for variable-width fields. More...
EnumKind	enum_kind {EnumKind::kEnumNone}
	Built-in enumeration the field encodes, for symbolic rendering. More...
bool	is_time {false}
	Field is a nanosecond timestamp eligible for date rendering. More...
bool	is_bool {false}
	Field encodes a boolean and should render as true / false. More...
bool	is_reserved {false}
	Field is a reserved slot a presentation layer may hide. More...
size_t	byte_offset {0}
	Byte offset within an indexed packed record, when applicable. More...
size_t	element_index {static_cast<size_t>(-1)}
	Declaration index within an indexed record, when applicable. More...

Detailed Description

Schema-neutral field descriptor returned by field enumeration.

Member Data Documentation

byte_offset

size_t vlink::zerocopy::MessageParser::Field::byte_offset {0}

Byte offset within an indexed packed record, when applicable.

element_index

size_t vlink::zerocopy::MessageParser::Field::element_index {static_cast<size_t>(-1)}

Declaration index within an indexed record, when applicable.

enum_kind

EnumKind vlink::zerocopy::MessageParser::Field::enum_kind {EnumKind::kEnumNone}

Built-in enumeration the field encodes, for symbolic rendering.

is_bool

bool vlink::zerocopy::MessageParser::Field::is_bool {false}

Field encodes a boolean and should render as true / false.

is_reserved

bool vlink::zerocopy::MessageParser::Field::is_reserved {false}

Field is a reserved slot a presentation layer may hide.

is_time

bool vlink::zerocopy::MessageParser::Field::is_time {false}

Field is a nanosecond timestamp eligible for date rendering.

name

std::string vlink::zerocopy::MessageParser::Field::name

Canonical path or collection element field name.

native_type

uint16_t vlink::zerocopy::MessageParser::Field::native_type {0}

Message-specific schema type tag, or zero when not applicable.

storage_size

uint16_t vlink::zerocopy::MessageParser::Field::storage_size {0}

Encoded field width in bytes, or zero for variable-width fields.

type

ValueType vlink::zerocopy::MessageParser::Field::type {ValueType::kValueUnknown}

Exact Value alternative returned for the field.

---

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

• include/vlink/zerocopy/message_parser.h