Complete filesystem-format dispatch surface used by the VFS. More...

#include <ra8_io_fsfmt.h>

Collaboration diagram for ra8_io_fsfmt_ops_t:

Data Fields
ra8_io_fsfmt_probe_fn_t	probe
	Recognise an on-disk volume.
ra8_io_fsfmt_mount_fn_t	mount
	Bind a block backend.
ra8_io_fsfmt_unmount_fn_t	unmount
	Release a mounted context.
ra8_io_fsfmt_open_fn_t	open
	Open a file stream.
ra8_io_fsfmt_close_fn_t	close
	Close a file stream.
ra8_io_fsfmt_read_fn_t	read
	Read stream bytes.
ra8_io_fsfmt_write_fn_t	write
	Write stream bytes.
ra8_io_fsfmt_seek_fn_t	seek
	Set stream offset.
ra8_io_fsfmt_tell_fn_t	tell
	Query stream offset.
ra8_io_fsfmt_size_fn_t	size
	Query stream size.
ra8_io_fsfmt_sync_fn_t	sync
	Flush software state, when supported.
ra8_io_fsfmt_stat_fn_t	stat
	Query path metadata.
ra8_io_fsfmt_listdir_fn_t	listdir
	Enumerate a directory.
ra8_io_fsfmt_dir_open_fn_t	dir_open
	Open incremental directory cursor.
ra8_io_fsfmt_dir_next_fn_t	dir_next
	Copy next cursor entry.
ra8_io_fsfmt_dir_close_fn_t	dir_close
	Close incremental directory cursor.
ra8_io_fsfmt_path_fn_t	unlink
	Remove a plain file.
ra8_io_fsfmt_rename_fn_t	rename
	Rename within the mount.
ra8_io_fsfmt_path_fn_t	mkdir
	Create a directory.
ra8_io_fsfmt_path_fn_t	rmdir
	Remove an empty directory.
ra8_io_fsfmt_space_fn_t	free_space
	Query free/total bytes.

Detailed Description

Complete filesystem-format dispatch surface used by the VFS.

A registered format owns these operations; the VFS never switches on FAT/exFAT or reaches into format internals. Optional operations may be NULL and are capability-gated as k_ra8_err_not_supported. All contexts and file handles remain implementation-owned; the VFS stores only pointers in fixed tables and allocates nothing.

Since: 0.1.0

Definition at line 179 of file ra8_io_fsfmt.h.

Field Documentation

◆ close

ra8_io_fsfmt_close_fn_t ra8_io_fsfmt_ops_t::close

Close a file stream.

Definition at line 184 of file ra8_io_fsfmt.h.

◆ dir_close

ra8_io_fsfmt_dir_close_fn_t ra8_io_fsfmt_ops_t::dir_close

Close incremental directory cursor.

Definition at line 195 of file ra8_io_fsfmt.h.

◆ dir_next

ra8_io_fsfmt_dir_next_fn_t ra8_io_fsfmt_ops_t::dir_next

Copy next cursor entry.

Definition at line 194 of file ra8_io_fsfmt.h.

◆ dir_open

ra8_io_fsfmt_dir_open_fn_t ra8_io_fsfmt_ops_t::dir_open

Open incremental directory cursor.

Definition at line 193 of file ra8_io_fsfmt.h.

◆ free_space

ra8_io_fsfmt_space_fn_t ra8_io_fsfmt_ops_t::free_space

Query free/total bytes.

Definition at line 200 of file ra8_io_fsfmt.h.

◆ listdir

ra8_io_fsfmt_listdir_fn_t ra8_io_fsfmt_ops_t::listdir

Enumerate a directory.

Definition at line 192 of file ra8_io_fsfmt.h.

◆ mkdir

ra8_io_fsfmt_path_fn_t ra8_io_fsfmt_ops_t::mkdir

Create a directory.

Definition at line 198 of file ra8_io_fsfmt.h.

◆ mount

ra8_io_fsfmt_mount_fn_t ra8_io_fsfmt_ops_t::mount

Bind a block backend.

Definition at line 181 of file ra8_io_fsfmt.h.

◆ open

ra8_io_fsfmt_open_fn_t ra8_io_fsfmt_ops_t::open

Open a file stream.

Definition at line 183 of file ra8_io_fsfmt.h.

◆ probe

ra8_io_fsfmt_probe_fn_t ra8_io_fsfmt_ops_t::probe

Recognise an on-disk volume.

Definition at line 180 of file ra8_io_fsfmt.h.

◆ read

ra8_io_fsfmt_read_fn_t ra8_io_fsfmt_ops_t::read

Read stream bytes.

Definition at line 185 of file ra8_io_fsfmt.h.

◆ rename

ra8_io_fsfmt_rename_fn_t ra8_io_fsfmt_ops_t::rename

Rename within the mount.

Definition at line 197 of file ra8_io_fsfmt.h.

◆ rmdir

ra8_io_fsfmt_path_fn_t ra8_io_fsfmt_ops_t::rmdir

Remove an empty directory.

Definition at line 199 of file ra8_io_fsfmt.h.

◆ seek

ra8_io_fsfmt_seek_fn_t ra8_io_fsfmt_ops_t::seek

Set stream offset.

Definition at line 187 of file ra8_io_fsfmt.h.

◆ size

ra8_io_fsfmt_size_fn_t ra8_io_fsfmt_ops_t::size

Query stream size.

Definition at line 189 of file ra8_io_fsfmt.h.

◆ stat

ra8_io_fsfmt_stat_fn_t ra8_io_fsfmt_ops_t::stat

Query path metadata.

Definition at line 191 of file ra8_io_fsfmt.h.

◆ sync

ra8_io_fsfmt_sync_fn_t ra8_io_fsfmt_ops_t::sync

Flush software state, when supported.

Definition at line 190 of file ra8_io_fsfmt.h.

◆ tell

ra8_io_fsfmt_tell_fn_t ra8_io_fsfmt_ops_t::tell

Query stream offset.

Definition at line 188 of file ra8_io_fsfmt.h.

◆ unlink

ra8_io_fsfmt_path_fn_t ra8_io_fsfmt_ops_t::unlink

Remove a plain file.

Definition at line 196 of file ra8_io_fsfmt.h.

◆ unmount

ra8_io_fsfmt_unmount_fn_t ra8_io_fsfmt_ops_t::unmount

Release a mounted context.

Definition at line 182 of file ra8_io_fsfmt.h.

◆ write

ra8_io_fsfmt_write_fn_t ra8_io_fsfmt_ops_t::write

Write stream bytes.

Definition at line 186 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