nRF5 SDK v15.3.0
Data Fields
fds_stat_t Struct Reference

File system statistics. More...

#include <fds.h>

Data Fields

uint16_t pages_available
 The number of pages available.
 
uint16_t open_records
 The number of open records.
 
uint16_t valid_records
 The number of valid records.
 
uint16_t dirty_records
 The number of deleted ("dirty") records.
 
uint16_t words_reserved
 The number of words reserved by fds_reserve().
 
uint16_t words_used
 The number of words written to flash, including those reserved for future writes.
 
uint16_t largest_contig
 The largest number of free contiguous words in the file system. More...
 
uint16_t freeable_words
 The largest number of words that can be reclaimed by garbage collection. More...
 
bool corruption
 Filesystem corruption has been detected. More...
 

Detailed Description

File system statistics.

Field Documentation

bool fds_stat_t::corruption

Filesystem corruption has been detected.

One or more corrupted records were detected. FDS will heal the filesystem automatically next time garbage collection is run, but some data may be lost.

Note
: This flag is unrelated to CRC failures.
uint16_t fds_stat_t::freeable_words

The largest number of words that can be reclaimed by garbage collection.

The actual amount of space freed by garbage collection might be less than this value if records are open while garbage collection is run.

uint16_t fds_stat_t::largest_contig

The largest number of free contiguous words in the file system.

This number indicates the largest record that can be stored by FDS. It takes into account all reservations for future writes.


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

Documentation feedback | Developer Zone | Subscribe | Updated