The record descriptor structure, used to manipulate a record. More...

#include <fds.h>

Data Fields
uint32_t	record_id
	The unique record ID.
uint32_t const *	p_rec
	The last known record address in flash.
uint16_t	vpage_id
	The virtual page ID in which the record is stored.
uint16_t	gc_magic
	Number of times the GC algorithm has been run.
uint16_t	ptr_magic
	Used to verify the validity of p_rec.

Detailed Description

The record descriptor structure, used to manipulate a record.

Note:: This structure is meant to be opaque to the user, who does not need to access any of its fields.; This structure does not need special initialization.

Warning:: Do not reuse the same descriptor for different records. If you do, be sure to set its fields to zero.

Definition at line 105 of file fds.h.

Field Documentation

uint16_t gc_magic

Number of times the GC algorithm has been run.

Definition at line 110 of file fds.h.

uint32_t const* p_rec

The last known record address in flash.

Definition at line 108 of file fds.h.

Used to verify the validity of p_rec.

Definition at line 111 of file fds.h.

The unique record ID.

Definition at line 107 of file fds.h.

uint16_t vpage_id

The virtual page ID in which the record is stored.

Definition at line 109 of file fds.h.