fw_fs_stream_iface Struct Reference

Open-file backend operations over caller-supplied state. More...

#include <fw_if_fs_backend.h>

Data Fields
ra8_err_t(*	open )(void *ctx, const char *path, fw_fs_open_mode_t mode, void *file_state, uint32_t state_bytes)
	Initialize caller workspace for one path and open mode.
ra8_err_t(*	read )(void *ctx, void *file_state, uint8_t *dst, uint32_t cap, uint32_t *out_read)
	Read bytes at the current stream position.
ra8_err_t(*	write )(void *ctx, void *file_state, const uint8_t *src, uint32_t len, uint32_t *out_written)
	Write bytes at the current stream position.
ra8_err_t(*	seek )(void *ctx, void *file_state, uint64_t absolute_offset)
	Set the absolute stream position.
ra8_err_t(*	tell )(void *ctx, void *file_state, uint64_t *out_offset)
	Report the current absolute stream position.
ra8_err_t(*	size )(void *ctx, void *file_state, uint64_t *out_size)
	Report the current file length.
ra8_err_t(*	sync )(void *ctx, void *file_state)
	Request backend file durability when supported.
ra8_err_t(*	close )(void *ctx, void *file_state)
	Close the file and release its caller workspace.

Detailed Description

Open-file backend operations over caller-supplied state.

sync may be NULL only when k_fw_fs_cap_file_sync is absent. Reads and writes must never report a count larger than the caller's supplied bound, including when returning an error.

Definition at line 72 of file fw_if_fs_backend.h.

Field Documentation

close

ra8_err_t(* fw_fs_stream_iface::close) (void *ctx, void *file_state)

Close the file and release its caller workspace.

Definition at line 93 of file fw_if_fs_backend.h.

Referenced by internal_interfaces().

open

ra8_err_t(* fw_fs_stream_iface::open) (void *ctx, const char *path, fw_fs_open_mode_t mode, void *file_state, uint32_t state_bytes)

Initialize caller workspace for one path and open mode.

Definition at line 74 of file fw_if_fs_backend.h.

Referenced by fw_fs_open(), and internal_interfaces().

read

ra8_err_t(* fw_fs_stream_iface::read) (void *ctx, void *file_state, uint8_t *dst, uint32_t cap, uint32_t *out_read)

Read bytes at the current stream position.

Definition at line 80 of file fw_if_fs_backend.h.

Referenced by internal_interfaces().

seek

ra8_err_t(* fw_fs_stream_iface::seek) (void *ctx, void *file_state, uint64_t absolute_offset)

Set the absolute stream position.

Definition at line 85 of file fw_if_fs_backend.h.

Referenced by internal_interfaces().

size

ra8_err_t(* fw_fs_stream_iface::size) (void *ctx, void *file_state, uint64_t *out_size)

Report the current file length.

Definition at line 89 of file fw_if_fs_backend.h.

Referenced by internal_interfaces().

sync

ra8_err_t(* fw_fs_stream_iface::sync) (void *ctx, void *file_state)

Request backend file durability when supported.

Definition at line 91 of file fw_if_fs_backend.h.

Referenced by internal_fw_fs_caps_validate().

tell

ra8_err_t(* fw_fs_stream_iface::tell) (void *ctx, void *file_state, uint64_t *out_offset)

Report the current absolute stream position.

Definition at line 87 of file fw_if_fs_backend.h.

Referenced by internal_interfaces().

write

ra8_err_t( * fw_fs_stream_iface::write) (void *ctx, void *file_state, const uint8_t *src, uint32_t len, uint32_t *out_written)

Write bytes at the current stream position.

Definition at line 82 of file fw_if_fs_backend.h.

Referenced by internal_interfaces().

---

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

• libs/if/inc/fw_if_fs_backend.h