mdl_storage_vfs_t Struct Reference

Caller-owned VFS transaction context. More...

#include <mdl_storage_vfs.h>

Collaboration diagram for mdl_storage_vfs_t:

Data Fields
ra8_io_vfs_file_t *	file
	Open private writer.
mdl_storage_vfs_validate_fn	validate
	Optional delegated check.
void *	validate_ctx
	Delegated check context.
uint64_t	bytes_written
	Successful appended bytes.
mdl_storage_vfs_state_t	state
	Transaction lifecycle.
char	stage_leaf [k_mdl_storage_vfs_stage_leaf_capacity]
	Owned leaf.
char	destination [k_mdl_storage_vfs_path_capacity]
	Final path.
char	staging_path [k_mdl_storage_vfs_path_capacity]
	Private path.

Detailed Description

Caller-owned VFS transaction context.

Declare one instance for each concurrently active downloader. Its fixed buffers hold the canonical final and sibling-staging paths. Treat all fields as private after mdl_storage_vfs_init.

Invariant

file is non-null exactly while state is _writing.

staging_path and destination share one mount and parent.

No field points into dynamically allocated storage.

Since

0.1.0

Definition at line 121 of file mdl_storage_vfs.h.

Field Documentation

bytes_written

uint64_t mdl_storage_vfs_t::bytes_written

Successful appended bytes.

Definition at line 129 of file mdl_storage_vfs.h.

Referenced by internal_begin(), internal_commit(), internal_validate(), and internal_write().

destination

char mdl_storage_vfs_t::destination[k_mdl_storage_vfs_path_capacity]

Final path.

Definition at line 135 of file mdl_storage_vfs.h.

Referenced by internal_begin(), internal_begin_prepare_stage(), internal_build_stage(), internal_commit(), and internal_parent_check().

file

ra8_io_vfs_file_t* mdl_storage_vfs_t::file

Open private writer.

Definition at line 123 of file mdl_storage_vfs.h.

Referenced by internal_begin(), internal_close_writer(), and internal_write().

stage_leaf

char mdl_storage_vfs_t::stage_leaf[k_mdl_storage_vfs_stage_leaf_capacity]

Owned leaf.

Definition at line 133 of file mdl_storage_vfs.h.

Referenced by internal_begin_prepare_stage(), internal_build_stage(), and mdl_storage_vfs_init().

staging_path

char mdl_storage_vfs_t::staging_path[k_mdl_storage_vfs_path_capacity]

Private path.

Definition at line 137 of file mdl_storage_vfs.h.

Referenced by internal_abort_stage(), internal_begin(), internal_begin_prepare_stage(), internal_build_stage(), internal_commit(), internal_staged_file_check(), and internal_validate().

state

mdl_storage_vfs_state_t mdl_storage_vfs_t::state

Transaction lifecycle.

Definition at line 131 of file mdl_storage_vfs.h.

Referenced by internal_abort(), internal_abort_stage(), internal_begin(), internal_close_writer(), internal_commit(), internal_validate(), and internal_write().

validate

mdl_storage_vfs_validate_fn mdl_storage_vfs_t::validate

Optional delegated check.

Definition at line 125 of file mdl_storage_vfs.h.

Referenced by internal_validate(), and mdl_storage_vfs_init().

validate_ctx

void* mdl_storage_vfs_t::validate_ctx

Delegated check context.

Definition at line 127 of file mdl_storage_vfs.h.

Referenced by internal_validate(), and mdl_storage_vfs_init().

---

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

• apps/shared_libs/mdl_storage_vfs/inc/mdl_storage_vfs.h