The record descriptor structure that is used to manipulate records. More...

#include <fds.h>

Data Fields
uint32_t	record_id
	The unique record ID. More...

uint32_t const *	p_record
	The last known location of the record in flash. More...

uint16_t	gc_run_count
	Number of times garbage collection has been run. More...

bool	record_is_open
	Whether the record is currently open. More...

Detailed Description

The record descriptor structure that is used to manipulate records.

This structure is used by the FDS module. You must provide the descriptor to the module when you manipulate existing records. However, you should never modify it or use any of its fields.

Note: Never reuse the same descriptor for different records.

Definition at line 132 of file fds.h.

Field Documentation

◆ gc_run_count

uint16_t gc_run_count

Number of times garbage collection has been run.

Definition at line 136 of file fds.h.

◆ p_record

uint32_t const* p_record

The last known location of the record in flash.

Definition at line 135 of file fds.h.

◆ record_id

uint32_t record_id

The unique record ID.

Definition at line 134 of file fds.h.

◆ record_is_open

bool record_is_open

Whether the record is currently open.

Definition at line 137 of file fds.h.

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