Information about each field to be read or written. More...

#include <format.h>

Data Fields
int	index
	Index of this field (usually on `fieldMap` in the parent format_t). More...

int(*	prefix )(uint8_t buffer, int limit, formatDirection_t direction, format_t fmt, formatField_t *field)
	Pack/unpack prefix of field.

int(*	body )(uint8_t buffer, int limit, formatDirection_t direction, format_t fmt, formatField_t *field)
	Pack/unpack actual field contents.

int(*	suffix )(uint8_t buffer, int limit, formatDirection_t direction, format_t fmt, formatField_t *field)
	Pack/unpack suffix of field.

int	size
	Default size of the field. More...

void *	data
	Pointer to actual field data. More...

int	bodySize
	Actual size of the field, as returned by `body`. More...

Detailed Description

Information about each field to be read or written.

Field Documentation

int formatField_t::bodySize

Actual size of the field, as returned by body.

Default to the same value of size.

void* formatField_t::data

Pointer to actual field data.

Should be filled by the body function.

int formatField_t::index

Index of this field (usually on fieldMap in the parent format_t).

If not used should be set to -1.

int formatField_t::size

Default size of the field.

Should be filled by user, zero if not relevant.

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