sol_memdesc_structure_member Struct Reference

Description of a structure member. More...

#include <sol-memdesc.h>

Data Fields
struct sol_memdesc	base
bool	detail: 1
	whenever member is extended detail. More...
const char *	name
	memory name, such as the member name in a structure. More...
uint16_t	offset
	offset in bytes relative to containing structure memory. More...
bool	optional: 1
	whenever member is mandatory in serialization and parsing. More...

Detailed Description

Description of a structure member.

This description extends the base description and adds name, offset and some flags.

See Also

struct sol_memdesc

Field Documentation

struct sol_memdesc sol_memdesc_structure_member::base

Referenced by sol_memdesc_get_structure_member_memory().

bool sol_memdesc_structure_member::detail

whenever member is extended detail.

If true, should only be included in serialization if detail is wanted.

const char* sol_memdesc_structure_member::name

memory name, such as the member name in a structure.

This may be used in serialization and parsing to provide a descriptive identifier.

Referenced by sol_memdesc_find_structure_member().

uint16_t sol_memdesc_structure_member::offset

offset in bytes relative to containing structure memory.

If this is a member of a structure, then it's the offsetof(struct, member). It is used to access the actual memory.

Referenced by sol_memdesc_get_as_int64(), sol_memdesc_get_as_uint64(), sol_memdesc_get_structure_member_memory(), sol_memdesc_set_as_int64(), and sol_memdesc_set_as_uint64().

bool sol_memdesc_structure_member::optional

whenever member is mandatory in serialization and parsing.

If false, must exist when serializing/parsing. if true, then defcontent could be used if missing from input.

---

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

• src/lib/datatypes/include/sol-memdesc.h