ring_api 0.1.0

//! Endpoint for querying the status of a job.

use std::borrow::Cow;
use super::Request;
use crate::{
    settings::Settings,
    job::{ JobId, JobStatus },
};

/// A status request.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Status {
    /// The ID of the job we are requesting the status for.
    pub job_id: JobId,
}

/// Response to a status request.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct StatusResponse {
    /// The job ID is echoed back.
    #[serde(rename = "_id")]
    pub job_id: JobId,
    /// The current status of the job.
    pub status: JobStatus,
    /// If a PDB ID has been submitted, it is captured here.
    #[serde(default, rename = "pdbName", skip_serializing_if = "Option::is_none")]
    pub pdb_id: Option<String>,
    /// If a file name has been supplied upon submission, it is captured here.
    #[serde(default, rename = "fileName", skip_serializing_if = "Option::is_none")]
    pub file_name: Option<String>,
    /// The job settings are echoed back.
    #[serde(flatten, default)]
    pub settings: Settings,
}

impl Request for Status {
    type Body = ();
    type Response = StatusResponse;

    fn endpoint(&self) -> Cow<str> {
        format!("/status/{}", self.job_id).into()
    }
}