File storage_defs.h

FileList > defs > storage_defs > storage_defs.h

Go to the source code of this file

Common definitions for store-storage_interface objects. More...

• #include "stdlib.h"
• #include "stdint.h"

Public Types

Type	Name
typedef const char *(*	storage_read_funptr_t
typedef uint8_t(*	storage_write_funptr_t

Macros

Type	Name
define	STORE_DEFS_READ_FAIL (1u) We use bit 0 to indicate a fail. Specific failures writed in higher bits.
define	STORE_DEFS_READ_SUCCESS (0u) Success is a 0. That lets us use hight bits for store-storage_interface specific codes.
define	STORE_DEFS_WRITE_FAIL (1u) We use bit 0 to indicate a fail. Specific failures writed in higher bits.
define	STORE_DEFS_WRITE_SUCCESS (0u) Success is a 0. That lets us use hight bits for store-storage_interface specific codes.

Detailed Description

Author:

Joe Starr

Public Types Documentation

typedef storage_read_funptr_t

typedef const char *(* storage_read_funptr_t) (const char *key, const char *index);

---

typedef storage_write_funptr_t

typedef uint8_t(* storage_write_funptr_t) (const char *key, const char *index, const char *value);

---

Macro Definition Documentation

define STORE_DEFS_READ_FAIL

We use bit 0 to indicate a fail. Specific failures writed in higher bits.

#define STORE_DEFS_READ_FAIL `(1u)`

---

define STORE_DEFS_READ_SUCCESS

Success is a 0. That lets us use hight bits for store-storage_interface specific codes.

#define STORE_DEFS_READ_SUCCESS `(0u)`

---

define STORE_DEFS_WRITE_FAIL

We use bit 0 to indicate a fail. Specific failures writed in higher bits.

#define STORE_DEFS_WRITE_FAIL `(1u)`

---

define STORE_DEFS_WRITE_SUCCESS

Success is a 0. That lets us use hight bits for store-storage_interface specific codes.

#define STORE_DEFS_WRITE_SUCCESS `(0u)`

---

---

The documentation for this class was generated from the following file source/defs/storage_defs/storage_defs.h