vTable with the ustream APIs. More...

#include <ustream_base.h>

Data Fields
AZ_ULIB_RESULT(*	set_position )(AZ_USTREAM *ustream_instance, offset_t position)

AZ_ULIB_RESULT(*	reset )(AZ_USTREAM *ustream_instance)

AZ_ULIB_RESULT(*	read )(AZ_USTREAM ustream_instance, uint8_t const buffer, size_t buffer_length, size_t *const size)

AZ_ULIB_RESULT(*	get_remaining_size )(AZ_USTREAM ustream_instance, size_t const size)

AZ_ULIB_RESULT(*	get_position )(AZ_USTREAM ustream_instance, offset_t const position)

AZ_ULIB_RESULT(*	release )(AZ_USTREAM *ustream_instance, offset_t position)

AZ_ULIB_RESULT(*	clone )(AZ_USTREAM ustream_instance_clone, AZ_USTREAM ustream_instance, offset_t offset)

AZ_ULIB_RESULT(*	dispose )(AZ_USTREAM *ustream_instance)

Detailed Description

vTable with the ustream APIs.

Any module that exposes the ustream shall implement the functions on this vTable.

Any code that will use an exposed ustream shall call the APIs using the az_ustream_... inline functions.

Definition at line 351 of file ustream_base.h.

Field Documentation

◆ clone

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::clone) (AZ_USTREAM *ustream_instance_clone, AZ_USTREAM *ustream_instance, offset_t offset)

concrete clone implementation

Definition at line 360 of file ustream_base.h.

◆ dispose

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::dispose) (AZ_USTREAM *ustream_instance)

concrete dispose implementation

Definition at line 362 of file ustream_base.h.

◆ get_position

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::get_position) (AZ_USTREAM *ustream_instance, offset_t *const position)

concrete get_position implementation

Definition at line 358 of file ustream_base.h.

◆ get_remaining_size

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::get_remaining_size) (AZ_USTREAM *ustream_instance, size_t *const size)

concrete get_remaining_size implementation

Definition at line 357 of file ustream_base.h.

◆ read

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::read) (AZ_USTREAM *ustream_instance, uint8_t *const buffer, size_t buffer_length, size_t *const size)

concrete read implementation

Definition at line 355 of file ustream_base.h.

◆ release

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::release) (AZ_USTREAM *ustream_instance, offset_t position)

concrete release implementation

Definition at line 359 of file ustream_base.h.

◆ reset

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::reset) (AZ_USTREAM *ustream_instance)

concrete reset implementation

Definition at line 354 of file ustream_base.h.

◆ set_position

AZ_ULIB_RESULT(* AZ_USTREAM_INTERFACE_TAG::set_position) (AZ_USTREAM *ustream_instance, offset_t position)

concrete set_position implementation

Definition at line 353 of file ustream_base.h.

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

inc/ustream_base.h

Data Fields