MIP Serialization [C]

(De)serialization in C. More...

Collaboration diagram for MIP Serialization [C]:

Classes
struct	mip::C::mip_serializer
	Structure used for serialization. More...

Typedefs
typedef struct mip::C::mip_serializer	mip::C::mip_serializer
	Structure used for serialization. More...

Functions
void	mip::C::mip_serializer_init_insertion (mip_serializer *serializer, uint8_t *buffer, size_t buffer_size)
void	mip::C::mip_serializer_init_extraction (mip_serializer *serializer, const uint8_t *buffer, size_t buffer_size)
void	mip::C::mip_serializer_init_from_field (mip_serializer *serializer, const mip_field *field)
size_t	mip::C::mip_serializer_capacity (const mip_serializer *serializer)
size_t	mip::C::mip_serializer_length (const mip_serializer *serializer)
remaining_count	mip::C::mip_serializer_remaining (const mip_serializer *serializer)
bool	mip::C::mip_serializer_is_ok (const mip_serializer *serializer)
bool	mip::C::mip_serializer_is_complete (const mip_serializer *serializer)
void	mip::C::insert_bool (mip_serializer *serializer, bool value)
void	mip::C::insert_char (mip_serializer *serializer, char value)
void	mip::C::insert_u8 (mip_serializer *serializer, uint8_t value)
void	mip::C::insert_u16 (mip_serializer *serializer, uint16_t value)
void	mip::C::insert_u32 (mip_serializer *serializer, uint32_t value)
void	mip::C::insert_u64 (mip_serializer *serializer, uint64_t value)
void	mip::C::insert_s8 (mip_serializer *serializer, int8_t value)
void	mip::C::insert_s16 (mip_serializer *serializer, int16_t value)
void	mip::C::insert_s32 (mip_serializer *serializer, int32_t value)
void	mip::C::insert_s64 (mip_serializer *serializer, int64_t value)
void	mip::C::insert_float (mip_serializer *serializer, float value)
void	mip::C::insert_double (mip_serializer *serializer, double value)
void	mip::C::extract_bool (mip_serializer *serializer, bool *value)
void	mip::C::extract_char (mip_serializer *serializer, char *value)
void	mip::C::extract_u8 (mip_serializer *serializer, uint8_t *value)
void	mip::C::extract_u16 (mip_serializer *serializer, uint16_t *value)
void	mip::C::extract_u32 (mip_serializer *serializer, uint32_t *value)
void	mip::C::extract_u64 (mip_serializer *serializer, uint64_t *value)
void	mip::C::extract_s8 (mip_serializer *serializer, int8_t *value)
void	mip::C::extract_s16 (mip_serializer *serializer, int16_t *value)
void	mip::C::extract_s32 (mip_serializer *serializer, int32_t *value)
void	mip::C::extract_s64 (mip_serializer *serializer, int64_t *value)
void	mip::C::extract_float (mip_serializer *serializer, float *value)
void	mip::C::extract_double (mip_serializer *serializer, double *value)
void	mip::C::extract_count (mip_serializer *serializer, uint8_t *count_out, uint8_t max_count)

Detailed Description

(De)serialization in C.

Typedef Documentation

mip_serializer

typedef struct mip::C::mip_serializer mip::C::mip_serializer

Structure used for serialization.

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

extract_bool()

void mip::C::extract_bool	(	mip_serializer *	serializer,
		bool *	value
	)

extract_char()

void mip::C::extract_char	(	mip_serializer *	serializer,
		char *	value
	)

extract_count()

void mip::C::extract_count	(	mip_serializer *	serializer,
		uint8_t *	count_out,
		uint8_t	max_count
	)

extract_double()

void mip::C::extract_double	(	mip_serializer *	serializer,
		double *	value
	)

extract_float()

void mip::C::extract_float	(	mip_serializer *	serializer,
		float *	value
	)

extract_s16()

void mip::C::extract_s16	(	mip_serializer *	serializer,
		int16_t *	value
	)

extract_s32()

void mip::C::extract_s32	(	mip_serializer *	serializer,
		int32_t *	value
	)

extract_s64()

void mip::C::extract_s64	(	mip_serializer *	serializer,
		int64_t *	value
	)

extract_s8()

void mip::C::extract_s8	(	mip_serializer *	serializer,
		int8_t *	value
	)

extract_u16()

void mip::C::extract_u16	(	mip_serializer *	serializer,
		uint16_t *	value
	)

extract_u32()

void mip::C::extract_u32	(	mip_serializer *	serializer,
		uint32_t *	value
	)

extract_u64()

void mip::C::extract_u64	(	mip_serializer *	serializer,
		uint64_t *	value
	)

extract_u8()

void mip::C::extract_u8	(	mip_serializer *	serializer,
		uint8_t *	value
	)

insert_bool()

void mip::C::insert_bool	(	mip_serializer *	serializer,
		bool	value
	)

insert_char()

void mip::C::insert_char	(	mip_serializer *	serializer,
		char	value
	)

insert_double()

void mip::C::insert_double	(	mip_serializer *	serializer,
		double	value
	)

insert_float()

void mip::C::insert_float	(	mip_serializer *	serializer,
		float	value
	)

insert_s16()

void mip::C::insert_s16	(	mip_serializer *	serializer,
		int16_t	value
	)

insert_s32()

void mip::C::insert_s32	(	mip_serializer *	serializer,
		int32_t	value
	)

insert_s64()

void mip::C::insert_s64	(	mip_serializer *	serializer,
		int64_t	value
	)

insert_s8()

void mip::C::insert_s8	(	mip_serializer *	serializer,
		int8_t	value
	)

insert_u16()

void mip::C::insert_u16	(	mip_serializer *	serializer,
		uint16_t	value
	)

insert_u32()

void mip::C::insert_u32	(	mip_serializer *	serializer,
		uint32_t	value
	)

insert_u64()

void mip::C::insert_u64	(	mip_serializer *	serializer,
		uint64_t	value
	)

insert_u8()

void mip::C::insert_u8	(	mip_serializer *	serializer,
		uint8_t	value
	)

mip_serializer_capacity()

size_t mip::C::mip_serializer_capacity

(

const mip_serializer *

serializer

)

mip_serializer_init_extraction()

void mip::C::mip_serializer_init_extraction	(	mip_serializer *	serializer,
		const uint8_t *	buffer,
		size_t	buffer_size
	)

mip_serializer_init_from_field()

void mip::C::mip_serializer_init_from_field	(	mip_serializer *	serializer,
		const mip_field *	field
	)

mip_serializer_init_insertion()

void mip::C::mip_serializer_init_insertion	(	mip_serializer *	serializer,
		uint8_t *	buffer,
		size_t	buffer_size
	)

mip_serializer_is_complete()

bool mip::C::mip_serializer_is_complete

(

const mip_serializer *

serializer

)

mip_serializer_is_ok()

bool mip::C::mip_serializer_is_ok

(

const mip_serializer *

serializer

)

mip_serializer_length()

size_t mip::C::mip_serializer_length

(

const mip_serializer *

serializer

)

mip_serializer_remaining()

remaining_count mip::C::mip_serializer_remaining

(

const mip_serializer *

serializer

)