Struct slurm::JobDescriptorOwned
[−]
[src]
pub struct JobDescriptorOwned(_);
An owned version of JobDescriptor.
Methods
impl JobDescriptorOwned[src]
pub fn new() -> Self[src]
Create a new, defaulted job descriptor.
pub fn set_argv<I: IntoIterator<Item = S>, S: AsRef<str>>(
&mut self,
argv: I
) -> &mut Self[src]
&mut self,
argv: I
) -> &mut Self
Specify the command-line arguments of the job.
pub fn set_environment<I: IntoIterator<Item = S>, S: AsRef<str>>(
&mut self,
env: I
) -> &mut Self[src]
&mut self,
env: I
) -> &mut Self
Explicitly specify the UNIX environment of the job.
pub fn inherit_environment(&mut self) -> &mut Self[src]
Set the UNIX environment of the job to match that of the current process.
This will panic if any environment variables are not decodable as Unicode. This limitation could be worked around with some developer effort.
pub fn set_name<S: AsRef<str>>(&mut self, name: S) -> &mut Self[src]
Set this job's name.
pub fn set_partition<S: AsRef<str>>(&mut self, partition: S) -> &mut Self[src]
Set this job's partition.
pub fn set_script<S: AsRef<str>>(&mut self, script: S) -> &mut Self[src]
Set the contents of this job's wrapper shell script.
This is the textual content of a shell script that will be executed as
the batch job wrapper. It should start with a shebang (#!) line.
pub fn set_stderr_path<S: AsRef<str>>(&mut self, path: S) -> &mut Self[src]
Set the path that will be used as this job's standard error stream.
pub fn set_stdin_path<S: AsRef<str>>(&mut self, path: S) -> &mut Self[src]
Set the path that will be used as this job's standard input stream.
pub fn set_stdout_path<S: AsRef<str>>(&mut self, path: S) -> &mut Self[src]
Set the path that will be used as this job's standard output stream.
pub fn set_work_dir<S: AsRef<str>>(&mut self, work_dir: S) -> &mut Self[src]
Set this job's working directory.
The working directory should be one that exists on all worker nodes of the cluster.
pub fn set_work_dir_cwd(&mut self) -> Result<&mut Self, Error>[src]
Set this job's working directory to the current process's current directory.
See std::env::current_dir for an explanation of the cases in which
this operation can fail.
Methods from Deref<Target = JobDescriptor>
pub fn gid(&self) -> u32[src]
Get the group ID associated with this job.
pub fn set_gid(&mut self, value: u32) -> &mut Self[src]
Set the group ID associated with this job.
pub fn set_gid_current(&mut self) -> &mut Self[src]
Set the group ID associated with this job to that of the current process.
pub fn name(&self) -> Cow<str>[src]
Get this job's name.
pub fn num_tasks(&self) -> u32[src]
Get the number of tasks within this job.
pub fn set_num_tasks(&mut self, value: u32) -> &mut Self[src]
Set the number of tasks within this job.
pub fn partition(&self) -> Cow<str>[src]
Get this job's assigned partition.
pub fn script(&self) -> Cow<str>[src]
Get the contents of this job's batch wrapper script.
pub fn stderr_path(&self) -> Cow<str>[src]
Get the path for this job's standard error stream.
pub fn stdin_path(&self) -> Cow<str>[src]
Get the path for this job's standard input stream.
pub fn stdout_path(&self) -> Cow<str>[src]
Get the path for this job's standard output stream.
pub fn time_limit(&self) -> u32[src]
Get the time limit associated with this job, measured in minutes.
pub fn set_time_limit(&mut self, minutes: u32) -> &mut Self[src]
Set the time limit associated with this job.
The value is measured in minutes.
pub fn uid(&self) -> u32[src]
Get the user ID associated with this job.
pub fn set_uid(&mut self, value: u32) -> &mut Self[src]
Set the user ID associated with this job.
pub fn set_uid_current(&mut self) -> &mut Self[src]
Set the user ID associated with this job to that of the current process.
pub fn work_dir(&self) -> Cow<str>[src]
Get the contents of this job's assigned working directory.
pub fn submit_batch(&self) -> Result<SubmitResponseMessageOwned, SlurmError>[src]
Submit this job to the batch processor.
TODO? Handle server-side errors reported in the response.
Trait Implementations
impl Debug for JobDescriptorOwned[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result[src]
Formats the value using the given formatter. Read more
impl Deref for JobDescriptorOwned[src]
type Target = JobDescriptor
The resulting type after dereferencing.
fn deref(&self) -> &JobDescriptor[src]
Dereferences the value.
impl DerefMut for JobDescriptorOwned[src]
fn deref_mut(&mut self) -> &mut JobDescriptor[src]
Mutably dereferences the value.