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

use serde_json::Value;

use crate::error::ApiError;

use super::RommClient;

impl RommClient {
    /// Triggers a server-side task by name (e.g., `"scan_library"`).
    pub async fn run_task(
        &self,
        task_name: &str,
        kwargs: Option<Value>,
    ) -> Result<Value, ApiError> {
        let path = format!("/api/tasks/run/{}", task_name);
        self.request_json("POST", &path, &[], kwargs).await
    }

    /// Polls the status of a running task by its ID.
    pub async fn get_task_status(&self, task_id: &str) -> Result<Value, ApiError> {
        let path = format!("/api/tasks/{}", task_id);
        self.request_json("GET", &path, &[], None).await
    }

    /// Enqueues all runnable tasks on the server.
    pub async fn run_all_tasks(&self) -> Result<Value, ApiError> {
        self.request_json("POST", "/api/tasks/run", &[], None).await
    }

    /// Lists all recent and active tasks.
    pub async fn list_tasks(&self) -> Result<Value, ApiError> {
        self.request_json("GET", "/api/tasks", &[], None).await
    }

    /// Returns the current status of the task queue.
    pub async fn get_tasks_queue_status(&self) -> Result<Value, ApiError> {
        self.request_json("GET", "/api/tasks/status", &[], None)
            .await
    }
}