romm-api 1.0.0

HTTP client and domain logic for the RomM API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

//! # romm-api
//!
//! Shared HTTP client, API types, and domain logic for RomM frontends (CLI, TUI, Android).
//!
//! ## Quick Start
//!
//! ```no_run
//! use romm_api::config::load_config;
//! use romm_api::client::RommClient;
//! use romm_api::error::RommError;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), RommError> {
//!     let config = load_config()?;
//!     let client = RommClient::new(&config, false)?;
//!
//!     let version = client.rom_server_version_from_heartbeat().await;
//!     println!("Connected to RomM server version: {:?}", version);
//!
//!     Ok(())
//! }
//! ```

/// HTTP client implementation for the RomM API.
pub mod client;
/// Configuration and authentication management.
pub mod config;
/// Internal core logic and shared utilities.
pub mod core;
/// Type-safe API endpoint definitions.
pub mod endpoints;
/// Typed error hierarchy (`ApiError`, `ConfigError`, `DownloadError`, `RommError`).
pub mod error;
/// Redaction helpers for tracing output (no secrets in logs).
pub mod log_redact;
pub use error::exit;
/// Feature compatibility helpers based on OpenAPI endpoint availability.
pub mod feature_compat;
/// OpenAPI parsing and endpoint lookup helpers.
pub mod openapi;
/// Shared data models and types.
pub mod types;
/// Auto-update logic.
pub mod update;