Struct slurm::JobRecord

pub struct JobRecord(_);

Accounting information about a job.

The following items in the Slurm API are not exposed in these Rust bindings:

pub struct slurmdb_job_rec_t {
    pub account: *mut c_char,
    pub admin_comment: *mut c_char,
    pub alloc_gres: *mut c_char,
    pub alloc_nodes: u32,
    pub array_max_tasks: u32,
    pub array_task_id: u32,
    pub array_task_str: *mut c_char,
    pub associd: u32,
    pub blockid: *mut c_char,
    pub cluster: *mut c_char,
    pub derived_ec: u32,
    pub derived_es: *mut c_char,
    pub first_step_ptr: *mut c_void,
    pub gid: u32,
    pub lft: u32,
    pub mcs_label: *mut c_char,
    pub partition: *mut c_char,
    pub pack_job_id: u32,
    pub pack_job_offset: u32,
    pub priority: u32,
    pub qosid: u32,
    pub req_cpus: u32,
    pub req_gres: *mut c_char,
    pub req_mem: u64,
    pub resvid: u32,
    pub resv_name: *mut c_char,
    pub show_full: u32,
    pub steps: List,
    pub track_steps: u16,
    pub tres_req_str: *mut c_char,
    pub uid: u32,
    pub used_gres: *mut c_char,
    pub user: *mut c_char,
    pub wckey: *mut c_char,
    pub wckeyid: u32,
    pub work_dir: *mut c_char,
}

(The above listing omits fields that would be handled by the JobStepRecordSharedFields trait.)

Methods

impl JobRecord

pub fn array_job_id(&self) -> Option<JobId>

Get the unique identifier of the array group this job belonged to.

Returns None if this job was not part of an array.

pub fn eligible_time(&self) -> Option<DateTime<Utc>>

Get the job's "eligible" time, or None if the job is not yet eligible to run.

pub fn job_id(&self) -> JobId

Get the job's ID number.

pub fn job_name(&self) -> Cow<str>

Get the job's name.

pub fn submit_time(&self) -> DateTime<Utc>

Get the job's submission time.

pub fn eligible_wait_duration(&self) -> Option<Duration>

Get the wallclock time spent waiting for the job to become eligible, or None if the job has not yet become eligible to run.

pub fn time_limit(&self) -> u32

Get the job's time limit in minutes.

pub fn wait_duration(&self) -> Option<Duration>

Get the wallclock time spent waiting for the job to start, or None if the job has not yet started.

This includes time that the job spent waiting to become eligible to run.

pub fn steps(&self) -> &SlurmList<StepRecord>

Steps.

Trait Implementations

impl Debug for JobRecord

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl UnownedFromSlurmPointer for JobRecord

fn unowned_from_slurm_pointer(ptr: *mut c_void) -> Self

Create an unowned wrapper object from a Slurm pointer.

impl JobStepRecordSharedFields for JobRecord

fn end_time(&self) -> Option<DateTime<Utc>>

Get the job/step's end time, or None if it has not yet ended.

fn exit_code(&self) -> Option<i32>

Get the job/step's exit code, or None if it has not yet ended.

fn max_vm_size(&self) -> Option<u64>

Get the maximum "virtual memory size" of the job/step, in kibibytes.

fn start_time(&self) -> Option<DateTime<Utc>>

Get the job/step's start time, or None if it has not yet started.

fn state(&self) -> JobState

Get the job/step's state.

fn wallclock_duration(&self) -> Option<Duration>

Get the wallclock time taken by the job/step: end time minus start time.