array_api.h File Reference

Abstract fixed-capacity array interface for DS modules. More...

#include "juno/macros.h"
#include "juno/memory/pointer_api.h"
#include "juno/status.h"
#include "juno/module.h"
#include <stddef.h>

Include dependency graph for array_api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	JUNO_DS_ARRAY_API_TAG
	Array API vtable. More...

Typedefs
typedef struct JUNO_DS_ARRAY_ROOT_TAG	JUNO_DS_ARRAY_ROOT_T
	Opaque array root carrying capacity and API pointer.
typedef struct JUNO_DS_ARRAY_API_TAG	JUNO_DS_ARRAY_API_T

Functions
struct JUNO_DS_ARRAY_ROOT_TAG	JUNO_MODULE_ROOT (JUNO_DS_ARRAY_API_T, size_t zCapacity;)
	Array root with capacity.
static JUNO_STATUS_T	JunoDs_ArrayApiVerify (const JUNO_DS_ARRAY_API_T *ptArrayApi)
	Verify that the array API provides all required functions.
static JUNO_STATUS_T	JunoDs_ArrayVerify (const JUNO_DS_ARRAY_ROOT_T *ptArray)
	Verify an array instance's capacity and API.
static JUNO_STATUS_T	JunoDs_ArrayVerifyIndex (const JUNO_DS_ARRAY_ROOT_T *ptArray, size_t iIndex)
	Verify an index is within array capacity.
static JUNO_STATUS_T	JunoDs_ArrayInit (JUNO_DS_ARRAY_ROOT_T *ptArray, const JUNO_DS_ARRAY_API_T *ptArrayApi, size_t iCapacity, JUNO_FAILURE_HANDLER_T pfcnFailureHdlr, JUNO_USER_DATA_T *pvUserData)
	Initialize an array root with capacity and API.

Detailed Description

Abstract fixed-capacity array interface for DS modules.

This API has been generated by LibJuno: https://www.robinonsay.com/libjuno/

Typedef Documentation

JUNO_DS_ARRAY_API_T

typedef struct JUNO_DS_ARRAY_API_TAG JUNO_DS_ARRAY_API_T

JUNO_DS_ARRAY_ROOT_T

typedef struct JUNO_DS_ARRAY_ROOT_TAG JUNO_DS_ARRAY_ROOT_T

Opaque array root carrying capacity and API pointer.

Function Documentation

JunoDs_ArrayApiVerify()

static JUNO_STATUS_T JunoDs_ArrayApiVerify ( const JUNO_DS_ARRAY_API_T *  ptArrayApi )

inlinestatic

Verify that the array API provides all required functions.