Struct RommClient 

pub struct RommClient { /* private fields */ }

High-level HTTP client for the ROMM API.

This type hides the details of reqwest and authentication headers behind a small, easy-to-mock interface that all frontends can share.

Implementations

impl RommClient

pub fn new(config: &Config, verbose: bool) -> Result<Self>

Construct a new client from the high-level Config.

verbose enables stderr request logging (method, path, query key names, status, timing). This is typically done once in main and the resulting RommClient is shared (by reference or cloning) with the chosen frontend.

pub fn verbose(&self) -> bool

pub async fn call<E>(&self, ep: &E) -> Result<E::Output>

where E: Endpoint, E::Output: DeserializeOwned,

Call a typed endpoint using the low-level request_json primitive.

pub async fn request_json( &self, method: &str, path: &str, query: &[(String, String)], body: Option<Value>, ) -> Result<Value>

Low-level helper that issues an HTTP request and returns raw JSON.

Higher-level helpers (such as typed Endpoint implementations) should prefer RommClient::call instead of using this directly.

pub async fn request_json_unauthenticated( &self, method: &str, path: &str, query: &[(String, String)], body: Option<Value>, ) -> Result<Value>

pub async fn rom_server_version_from_heartbeat(&self) -> Option<String>

RomM application version from GET /api/heartbeat (SYSTEM.VERSION), if the endpoint succeeds.

pub async fn fetch_openapi_json(&self) -> Result<String>

GET the OpenAPI spec from the server. Tries openapi_spec_urls in order (HTTP/HTTPS and /openapi.json vs /api/openapi.json). Uses resolve_openapi_root for the origin.

pub async fn download_rom<F>( &self, rom_id: u64, save_path: &Path, on_progress: F, ) -> Result<()>

where F: FnMut(u64, u64) + Send,

Download ROM(s) as a zip file to save_path, calling on_progress(received, total). Uses GET /api/roms/download?rom_ids={id}&filename=… per RomM OpenAPI.

If save_path already exists on disk (e.g. from a previous interrupted download), the client sends an HTTP Range header to resume from the existing byte offset. The server may reply with 206 Partial Content (resume works) or 200 OK (server doesn’t support ranges — restart from scratch).

pub async fn upload_rom<F>( &self, platform_id: u64, file_path: &Path, on_progress: F, ) -> Result<()>

where F: FnMut(u64, u64) + Send,

Upload a ROM file using the RomM chunked upload API.

pub async fn run_task( &self, task_name: &str, kwargs: Option<Value>, ) -> Result<Value>

Trigger a server-side task by name (e.g. "scan_library").

Sends POST /api/tasks/run/{task_name} with an optional JSON body (task_kwargs). Returns the raw TaskExecutionResponse JSON.

pub async fn get_task_status(&self, task_id: &str) -> Result<Value>

Poll the status of a running task.

Sends GET /api/tasks/{task_id}. Returns the raw status JSON.

Trait Implementations

impl Clone for RommClient

fn clone(&self) -> RommClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.