cfn_sal_utl_serialization_api_s Struct Reference

Virtual Method Table for Serialization Services. More...

#include <cfn_sal_utl_serialization.h>

Data Fields
cfn_hal_api_base_t	base
cfn_hal_error_code_t(*	encode )(cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, const void *data_ptr, uint8_t *out_buf, size_t out_size, size_t *bytes_written)
	Encodes a data structure into a buffer based on a schema.
cfn_hal_error_code_t(*	decode )(cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, const uint8_t *in_buf, size_t in_size, void *data_ptr, size_t *bytes_read)
	Decodes a buffer into a data structure based on a schema.
cfn_hal_error_code_t(*	encode_stream )(cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, const void *data_ptr, void *out_stream)
	Encodes a data structure into a stream based on a schema.
cfn_hal_error_code_t(*	decode_stream )(cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, void *in_stream, void *data_ptr)
	Decodes a stream into a data structure based on a schema.

Detailed Description

Virtual Method Table for Serialization Services.

Field Documentation

base

cfn_hal_api_base_t cfn_sal_utl_serialization_api_s::base

decode

cfn_hal_error_code_t(* cfn_sal_utl_serialization_api_s::decode) (cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, const uint8_t *in_buf, size_t in_size, void *data_ptr, size_t *bytes_read)

Decodes a buffer into a data structure based on a schema.

decode_stream

cfn_hal_error_code_t(* cfn_sal_utl_serialization_api_s::decode_stream) (cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, void *in_stream, void *data_ptr)

Decodes a stream into a data structure based on a schema.

encode

cfn_hal_error_code_t(* cfn_sal_utl_serialization_api_s::encode) (cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, const void *data_ptr, uint8_t *out_buf, size_t out_size, size_t *bytes_written)

Encodes a data structure into a buffer based on a schema.

encode_stream

cfn_hal_error_code_t(* cfn_sal_utl_serialization_api_s::encode_stream) (cfn_sal_utl_serialization_t *driver, const cfn_sal_utl_serialization_schema_t *schema, const void *data_ptr, void *out_stream)

Encodes a data structure into a stream based on a schema.

---

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

• include/utilities/cfn_sal_utl_serialization.h