Skip to main content

Module library_scan

Module library_scan 

Source
Expand description

Shared scan_library task trigger and optional wait (used by roms upload and scan).

Structs§

ScanLibraryOptions
Options for starting a library scan and optionally blocking until it finishes.
ScanLibraryStart

Enums§

ScanCacheInvalidate
After a successful --wait, optionally drop stale entries from the on-disk ROM list cache.

Constants§

SCAN_LIBRARY_TASK_NAME

Functions§

run_scan_library_flow
Start a library scan; optionally wait. Prints human text or JSON per format.
start_scan_library
POST scan_library with no kwargs (RomM task accepts no platform_id; see docs).
wait_for_scan_task
CLI: poll task status with an indicatif spinner (do not use under the TUI alternate screen).
wait_for_task_terminal
Poll GET /api/tasks/{task_id} every 2 seconds until terminal state or timeout. on_status is invoked with each non-terminal status string (may be empty on parse miss). On success returns the last status JSON (typically status == finished).