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 interface that all frontends can share.

Examples

let config = Config {
    base_url: "https://romm.example.com".to_string(),
    download_dir: "./downloads".to_string(),
    use_https: true,
    auth: None,
};
let client = RommClient::new(&config, false)?;

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

Returns true if verbose logging is enabled.

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

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

Executes a typed Endpoint and returns its deserialized output.

This is the preferred way to interact with the API when a typed endpoint definition exists.

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 a raw JSON Value.

Higher-level code should generally prefer RommClient::call.

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,

Downloads a ROM (or multiple ROMs as a zip) to the specified path.

This method supports resuming interrupted downloads by checking if the file already exists and sending an HTTP Range header.

Progress

The on_progress callback is called with (received_bytes, total_bytes).

pub async fn download_rom_with_cancel<F, C>( &self, rom_id: u64, save_path: &Path, is_cancelled: C, on_progress: &mut F, ) -> Result<()>

where F: FnMut(u64, u64) + Send, C: FnMut(u64, u64) -> bool + Send,

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

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

Uploads a ROM file to the server using the RomM chunked upload API.

This method splits the file into chunks (default 2MB) and uploads them sequentially, providing progress updates via the on_progress callback.

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

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

Arguments

• task_name - The internal name of the task to run.
• kwargs - Optional JSON arguments to pass to the task.

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

Polls the status of a running task by its ID.

pub async fn run_all_tasks(&self) -> Result<Value>

Enqueues all runnable tasks on the server.

pub async fn list_tasks(&self) -> Result<Value>

Lists all recent and active tasks.

pub async fn get_tasks_queue_status(&self) -> Result<Value>

Returns the current status of the task queue (active, queued, completed).

pub async fn upload_save_file( &self, rom_id: u64, emulator: Option<&str>, file_path: &Path, ) -> Result<Value>

Uploads a game save file to the server.

Arguments

• rom_id - ID of the ROM this save belongs to.
• emulator - Optional name of the emulator that generated the save.
• file_path - Local path to the save file.

pub async fn upload_state_file( &self, rom_id: u64, emulator: Option<&str>, file_path: &Path, ) -> Result<Value>

POST /api/states with multipart field stateFile.

pub async fn upload_screenshot_file( &self, rom_id: u64, file_path: &Path, ) -> Result<Value>

POST /api/screenshots with multipart field screenshotFile.

pub async fn upload_firmware_file( &self, platform_id: u64, file_path: &Path, ) -> Result<Value>

POST /api/firmware?platform_id= with multipart files (single file supported).

pub async fn get_bytes( &self, path: &str, query: &[(String, String)], ) -> Result<Vec<u8>>

Authenticated GET returning raw bytes (e.g. save/state/firmware file or gamelist export).

pub async fn post_bytes( &self, path: &str, query: &[(String, String)], json_body: Option<Value>, ) -> Result<Vec<u8>>

POST returning raw bytes (e.g. gamelist XML).

pub async fn upload_rom_manual( &self, rom_id: u64, file_path: &Path, ) -> Result<Value>

POST /api/roms/{id}/manuals — raw file body with x-upload-filename header.

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.