What a filesystem format supports. More...

#include <ra8_io_fsfmt.h>

Data Fields
uint32_t	directory_workspace_bytes
	Caller bytes required per cursor.
uint16_t	max_name_len
	Max UTF-8 bytes in one name, excluding NUL.
uint16_t	max_open_directories
	Concurrent caller-owned cursors.
uint8_t	directory_workspace_align
	Required cursor-workspace alignment.
bool	read_only
	true => no writes/creates/erases.
bool	supports_mkdir
	true => sub-directory creation.
bool	supports_rmdir
	true => empty-directory removal.
bool	supports_streaming_write
	true => open-for-write streaming.
bool	supports_timestamps
	true => stat reports entry timestamps.
bool	supports_free_space
	true => a cheap free-space query exists.
bool	supports_dir_cursor
	true => incremental directory cursor exists.
bool	supports_sync
	true => an explicit software sync op exists.
bool	atomic_rename
	true => rename is power-loss atomic.
bool	durable_sync
	true => sync reaches non-volatile media.
bool	unicode_names
	true => public names are strict UTF-8.
bool	case_sensitive
	true => names compare case-sensitive.

Detailed Description

What a filesystem format supports.

Lets a caller branch on a format's abilities (and lets the VFS return k_ra8_err_not_supported for an unsupported op) instead of assuming FAT semantics everywhere.

Since: 0.1.0

Definition at line 86 of file ra8_io_fsfmt.h.

Field Documentation

◆ atomic_rename

bool ra8_io_fsfmt_caps_t::atomic_rename

true => rename is power-loss atomic.

Definition at line 99 of file ra8_io_fsfmt.h.

◆ case_sensitive

bool ra8_io_fsfmt_caps_t::case_sensitive

true => names compare case-sensitive.

Definition at line 102 of file ra8_io_fsfmt.h.

◆ directory_workspace_align

uint8_t ra8_io_fsfmt_caps_t::directory_workspace_align

Required cursor-workspace alignment.

Definition at line 90 of file ra8_io_fsfmt.h.

Referenced by ra8_io_vfs_dir_open().

◆ directory_workspace_bytes

uint32_t ra8_io_fsfmt_caps_t::directory_workspace_bytes

Caller bytes required per cursor.

Definition at line 87 of file ra8_io_fsfmt.h.

◆ durable_sync

bool ra8_io_fsfmt_caps_t::durable_sync

true => sync reaches non-volatile media.

Definition at line 100 of file ra8_io_fsfmt.h.

◆ max_name_len

uint16_t ra8_io_fsfmt_caps_t::max_name_len

Max UTF-8 bytes in one name, excluding NUL.

Definition at line 88 of file ra8_io_fsfmt.h.

◆ max_open_directories

uint16_t ra8_io_fsfmt_caps_t::max_open_directories

Concurrent caller-owned cursors.

Definition at line 89 of file ra8_io_fsfmt.h.

◆ read_only

bool ra8_io_fsfmt_caps_t::read_only

true => no writes/creates/erases.

Definition at line 91 of file ra8_io_fsfmt.h.

◆ supports_dir_cursor

bool ra8_io_fsfmt_caps_t::supports_dir_cursor

true => incremental directory cursor exists.

Definition at line 97 of file ra8_io_fsfmt.h.

Referenced by ra8_io_vfs_dir_open().

◆ supports_free_space

bool ra8_io_fsfmt_caps_t::supports_free_space

true => a cheap free-space query exists.

Definition at line 96 of file ra8_io_fsfmt.h.

◆ supports_mkdir

bool ra8_io_fsfmt_caps_t::supports_mkdir

true => sub-directory creation.

Definition at line 92 of file ra8_io_fsfmt.h.

◆ supports_rmdir

bool ra8_io_fsfmt_caps_t::supports_rmdir

true => empty-directory removal.

Definition at line 93 of file ra8_io_fsfmt.h.

◆ supports_streaming_write

bool ra8_io_fsfmt_caps_t::supports_streaming_write

true => open-for-write streaming.

Definition at line 94 of file ra8_io_fsfmt.h.

◆ supports_sync

bool ra8_io_fsfmt_caps_t::supports_sync

true => an explicit software sync op exists.

Definition at line 98 of file ra8_io_fsfmt.h.

◆ supports_timestamps

bool ra8_io_fsfmt_caps_t::supports_timestamps

true => stat reports entry timestamps.

Definition at line 95 of file ra8_io_fsfmt.h.

◆ unicode_names

bool ra8_io_fsfmt_caps_t::unicode_names

true => public names are strict UTF-8.

Definition at line 101 of file ra8_io_fsfmt.h.

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

libs/ra8_io/inc/ra8_io_fsfmt.h

Data Fields