files_io_t Struct Reference

The card's task as the screen reaches it. Every function may be called on the task that renders; none of them waits for the card. More...

#include <files_screen.h>

Data Fields
bool(*)	submit (fm_req_t *req, void *ctx)
	Hand req to the card's task. The screen does not touch req again until idle() is true.
bool(*)	idle (void *ctx)
	Whether the request handed over last is answered.
void(*)	progress (uint64_t *done, uint64_t *total, void *ctx)
	The bytes done of the job under way, for the progress box. May be NULL: no progress shows.
void(*)	cancel (void *ctx)
	Ask the job under way to stop at its next chunk. May be NULL.
void(*)	bench (fm_bench_t *out, void *ctx)
	The bench as the write gate and the rules see it now: ARMED, the logger's open files, the IOmcu link. The log folders are the screen's own (log_viewer_tab_dir()). May be NULL: SAFE, nothing open, the link up.
const char *(*)	volume (void *ctx)
	The card's name for the root's header: its volume label, or the name in its CID. May be NULL: the header reads SD CARD.
card_state_t(*)	card (void *ctx)
	What the slot holds, for a pane with no card. May be NULL: no card.
void *	ctx

Detailed Description

The card's task as the screen reaches it. Every function may be called on the task that renders; none of them waits for the card.

Field Documentation

bench

void(*) files_io_t::bench(fm_bench_t *out, void *ctx)

The bench as the write gate and the rules see it now: ARMED, the logger's open files, the IOmcu link. The log folders are the screen's own (log_viewer_tab_dir()). May be NULL: SAFE, nothing open, the link up.

Parameters

out	takes the bench; its pointers outlive the frame
ctx	the io's context

cancel

void(*) files_io_t::cancel(void *ctx)

Ask the job under way to stop at its next chunk. May be NULL.

Parameters

ctx	the io's context

card

card_state_t(*) files_io_t::card(void *ctx)

What the slot holds, for a pane with no card. May be NULL: no card.

Parameters

ctx	the io's context

Returns

the slot's state

ctx

void* files_io_t::ctx

passed to every function

idle

bool(*) files_io_t::idle(void *ctx)

Whether the request handed over last is answered.

Parameters

ctx	the io's context

Returns

true with no request under way

progress

void(*) files_io_t::progress(uint64_t *done, uint64_t *total, void *ctx)

The bytes done of the job under way, for the progress box. May be NULL: no progress shows.

Parameters

done	takes the bytes done
total	takes the bytes to do
ctx	the io's context

submit

bool(*) files_io_t::submit(fm_req_t *req, void *ctx)

Hand req to the card's task. The screen does not touch req again until idle() is true.

Parameters

req	the request, filled
ctx	the io's context

Returns

false when it cannot be taken: one is under way, or the task could not start

volume

const char *(*) files_io_t::volume(void *ctx)

The card's name for the root's header: its volume label, or the name in its CID. May be NULL: the header reads SD CARD.

Parameters

ctx	the io's context

Returns

the name, "" for none

---

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

• shared/ui/include/files_screen.h