fds_record_desc_t Struct Reference

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

#include <fds.h>

Data Fields
uint32_t	record_id
uint32_t const *	p_rec
uint16_t	vpage_id
uint16_t	gc_magic
uint16_t	ptr_magic

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.

Field Documentation

uint16_t fds_record_desc_t::gc_magic

Number of times the GC algorithm has been run.

uint32_t const* fds_record_desc_t::p_rec

The last known record address in flash.

uint16_t fds_record_desc_t::ptr_magic

Used to verify the validity of p_rec.

uint32_t fds_record_desc_t::record_id

The unique record ID.

uint16_t fds_record_desc_t::vpage_id

The virtual page ID in which the record is stored.