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.

Implementations

impl RommClient

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

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

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

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

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

pub async fn download_url_with_cancel<F, C>( &self, url: &str, save_path: &Path, is_cancelled: C, on_progress: &mut F, ) -> Result<(), DownloadError>

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

Downloads an arbitrary URL to save_path, supporting auth headers and resume.

pub async fn download_url_with_query_with_cancel<F, C>( &self, url: &str, query: &[(String, String)], save_path: &Path, is_cancelled: C, on_progress: &mut F, ) -> Result<(), DownloadError>

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

Downloads an arbitrary URL and query to save_path, supporting auth headers and resume.

impl RommClient

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, ApiError>

GET the OpenAPI spec from the server.

impl RommClient

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

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

Executes a typed Endpoint and returns its deserialized output.

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

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

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

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

Authenticated GET returning raw bytes.

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

POST returning raw bytes.

impl RommClient

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

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

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

Polls the status of a running task by its ID.

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

Enqueues all runnable tasks on the server.

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

Lists all recent and active tasks.

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

Returns the current status of the task queue.

impl RommClient

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

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

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

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

Uploads a game save file to the server.

pub async fn upload_save_file_with_options( &self, rom_id: u64, file_path: &Path, options: &SaveUploadOptions<'_>, ) -> Result<Value, ApiError>

Uploads a game save file with sync-specific options.

pub async fn download_save_content( &self, save_id: u64, device_id: Option<&str>, session_id: Option<u64>, ) -> Result<Vec<u8>, ApiError>

Downloads save content from GET /api/saves/{id}/content.

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

POST /api/states with multipart field stateFile.

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

POST /api/screenshots with multipart field screenshotFile.

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

POST /api/firmware?platform_id= with multipart files.

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

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

impl RommClient

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

Construct a new client from the high-level Config.

pub fn verbose(&self) -> bool

Returns true if verbose logging is enabled.

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.