MicroStrain Serialization [C]

(De)serialization in C. More...

Classes
struct	microstrain::C::microstrain_serializer
	Structure used for serialization. More...

Typedefs
typedef struct microstrain::C::microstrain_serializer	microstrain::C::microstrain_serializer
	Structure used for serialization. More...

Functions
void	microstrain::C::microstrain_serializer_init_insertion (microstrain_serializer *serializer, uint8_t *buffer, size_t buffer_size)
void	microstrain::C::microstrain_serializer_init_extraction (microstrain_serializer *serializer, const uint8_t *buffer, size_t buffer_size)
size_t	microstrain::C::microstrain_serializer_capacity (const microstrain_serializer *serializer)
size_t	microstrain::C::microstrain_serializer_length (const microstrain_serializer *serializer)
int	microstrain::C::microstrain_serializer_remaining (const microstrain_serializer *serializer)
bool	microstrain::C::microstrain_serializer_is_ok (const microstrain_serializer *serializer)
bool	microstrain::C::microstrain_serializer_is_complete (const microstrain_serializer *serializer)
void	microstrain::C::microstrain_insert_bool (microstrain_serializer *serializer, bool value)
void	microstrain::C::microstrain_insert_char (microstrain_serializer *serializer, char value)
void	microstrain::C::microstrain_insert_u8 (microstrain_serializer *serializer, uint8_t value)
void	microstrain::C::microstrain_insert_u16 (microstrain_serializer *serializer, uint16_t value)
void	microstrain::C::microstrain_insert_u32 (microstrain_serializer *serializer, uint32_t value)
void	microstrain::C::microstrain_insert_u64 (microstrain_serializer *serializer, uint64_t value)
void	microstrain::C::microstrain_insert_s8 (microstrain_serializer *serializer, int8_t value)
void	microstrain::C::microstrain_insert_s16 (microstrain_serializer *serializer, int16_t value)
void	microstrain::C::microstrain_insert_s32 (microstrain_serializer *serializer, int32_t value)
void	microstrain::C::microstrain_insert_s64 (microstrain_serializer *serializer, int64_t value)
void	microstrain::C::microstrain_insert_float (microstrain_serializer *serializer, float value)
void	microstrain::C::microstrain_insert_double (microstrain_serializer *serializer, double value)
void	microstrain::C::microstrain_extract_bool (microstrain_serializer *serializer, bool *value)
void	microstrain::C::microstrain_extract_char (microstrain_serializer *serializer, char *value)
void	microstrain::C::microstrain_extract_u8 (microstrain_serializer *serializer, uint8_t *value)
void	microstrain::C::microstrain_extract_u16 (microstrain_serializer *serializer, uint16_t *value)
void	microstrain::C::microstrain_extract_u32 (microstrain_serializer *serializer, uint32_t *value)
void	microstrain::C::microstrain_extract_u64 (microstrain_serializer *serializer, uint64_t *value)
void	microstrain::C::microstrain_extract_s8 (microstrain_serializer *serializer, int8_t *value)
void	microstrain::C::microstrain_extract_s16 (microstrain_serializer *serializer, int16_t *value)
void	microstrain::C::microstrain_extract_s32 (microstrain_serializer *serializer, int32_t *value)
void	microstrain::C::microstrain_extract_s64 (microstrain_serializer *serializer, int64_t *value)
void	microstrain::C::microstrain_extract_float (microstrain_serializer *serializer, float *value)
void	microstrain::C::microstrain_extract_double (microstrain_serializer *serializer, double *value)
void	microstrain::C::microstrain_extract_count (microstrain_serializer *serializer, uint8_t *count_out, uint8_t max_count)

Detailed Description

Typedef Documentation

microstrain_serializer

typedef struct microstrain::C::microstrain_serializer microstrain::C::microstrain_serializer

Note

This should be considered an "opaque" structure; its members should be considered an internal implementation detail. Avoid accessing them directly as they are subject to change in future versions of this software.

Function Documentation

microstrain_serializer_init_insertion()

void microstrain::C::microstrain_serializer_init_insertion	(	microstrain_serializer *	serializer,
		uint8_t *	buffer,
		size_t	buffer_size
	)

microstrain_serializer_init_extraction()

void microstrain::C::microstrain_serializer_init_extraction	(	microstrain_serializer *	serializer,
		const uint8_t *	buffer,
		size_t	buffer_size
	)

microstrain_serializer_capacity()

size_t microstrain::C::microstrain_serializer_capacity

(

const microstrain_serializer *

serializer

)

microstrain_serializer_length()

size_t microstrain::C::microstrain_serializer_length

(

const microstrain_serializer *

serializer

)

microstrain_serializer_remaining()

int microstrain::C::microstrain_serializer_remaining

(

const microstrain_serializer *

serializer

)

microstrain_serializer_is_ok()

bool microstrain::C::microstrain_serializer_is_ok

(

const microstrain_serializer *

serializer

)

microstrain_serializer_is_complete()

bool microstrain::C::microstrain_serializer_is_complete

(

const microstrain_serializer *

serializer

)

microstrain_insert_bool()

void microstrain::C::microstrain_insert_bool	(	microstrain_serializer *	serializer,
		bool	value
	)

microstrain_insert_char()

void microstrain::C::microstrain_insert_char	(	microstrain_serializer *	serializer,
		char	value
	)

microstrain_insert_u8()

void microstrain::C::microstrain_insert_u8	(	microstrain_serializer *	serializer,
		uint8_t	value
	)

microstrain_insert_u16()

void microstrain::C::microstrain_insert_u16	(	microstrain_serializer *	serializer,
		uint16_t	value
	)

microstrain_insert_u32()

void microstrain::C::microstrain_insert_u32	(	microstrain_serializer *	serializer,
		uint32_t	value
	)

microstrain_insert_u64()

void microstrain::C::microstrain_insert_u64	(	microstrain_serializer *	serializer,
		uint64_t	value
	)

microstrain_insert_s8()

void microstrain::C::microstrain_insert_s8	(	microstrain_serializer *	serializer,
		int8_t	value
	)

microstrain_insert_s16()

void microstrain::C::microstrain_insert_s16	(	microstrain_serializer *	serializer,
		int16_t	value
	)

microstrain_insert_s32()

void microstrain::C::microstrain_insert_s32	(	microstrain_serializer *	serializer,
		int32_t	value
	)

microstrain_insert_s64()

void microstrain::C::microstrain_insert_s64	(	microstrain_serializer *	serializer,
		int64_t	value
	)

microstrain_insert_float()

void microstrain::C::microstrain_insert_float	(	microstrain_serializer *	serializer,
		float	value
	)

microstrain_insert_double()

void microstrain::C::microstrain_insert_double	(	microstrain_serializer *	serializer,
		double	value
	)

microstrain_extract_bool()

void microstrain::C::microstrain_extract_bool	(	microstrain_serializer *	serializer,
		bool *	value
	)

microstrain_extract_char()

void microstrain::C::microstrain_extract_char	(	microstrain_serializer *	serializer,
		char *	value
	)

microstrain_extract_u8()

void microstrain::C::microstrain_extract_u8	(	microstrain_serializer *	serializer,
		uint8_t *	value
	)

microstrain_extract_u16()

void microstrain::C::microstrain_extract_u16	(	microstrain_serializer *	serializer,
		uint16_t *	value
	)

microstrain_extract_u32()

void microstrain::C::microstrain_extract_u32	(	microstrain_serializer *	serializer,
		uint32_t *	value
	)

microstrain_extract_u64()

void microstrain::C::microstrain_extract_u64	(	microstrain_serializer *	serializer,
		uint64_t *	value
	)

microstrain_extract_s8()

void microstrain::C::microstrain_extract_s8	(	microstrain_serializer *	serializer,
		int8_t *	value
	)

microstrain_extract_s16()

void microstrain::C::microstrain_extract_s16	(	microstrain_serializer *	serializer,
		int16_t *	value
	)

microstrain_extract_s32()

void microstrain::C::microstrain_extract_s32	(	microstrain_serializer *	serializer,
		int32_t *	value
	)

microstrain_extract_s64()

void microstrain::C::microstrain_extract_s64	(	microstrain_serializer *	serializer,
		int64_t *	value
	)

microstrain_extract_float()

void microstrain::C::microstrain_extract_float	(	microstrain_serializer *	serializer,
		float *	value
	)

microstrain_extract_double()

void microstrain::C::microstrain_extract_double	(	microstrain_serializer *	serializer,
		double *	value
	)

microstrain_extract_count()

void microstrain::C::microstrain_extract_count	(	microstrain_serializer *	serializer,
		uint8_t *	count_out,
		uint8_t	max_count
	)