Enum SbatchOption 

pub enum SbatchOption {
    Account(String),
    AcctgFreq(String),
    Array(String),
    Batch(String),
    Bb(String),
    Bbf(String),
    Begin(String),
    Chdir(String),
    ClusterConstraint(String),
    Clusters(String),
    Comment(String),
    Constraint(String),
    Container(String),
    ContainerID(String),
    Contiguous,
    CoreSpec(String),
    CoresPerSocket(String),
    CPUFreq(String),
    CPUsPerGPU(String),
    CPUsPerTask(String),
    Deadline(String),
    DelayBoot(String),
    Dependency(String),
    Distribution(String),
    Error(String),
    Exclude(String),
    Exclusive(Option<String>),
    Export(String),
    ExportFile(String),
    Extra(String),
    ExtraNodeInfo(String),
    GetUserEnv(Option<String>),
    GID(String),
    GPUBind(String),
    GPUFreq(String),
    GPUs(String),
    GPUsPerNode(String),
    GPUsPerSocket(String),
    GPUsPerTask(String),
    Gres(String),
    GresFlags(String),
    Help,
    Hint(String),
    Hold,
    IgnorePbs,
    Input(String),
    JobName(String),
    KillOnInvalidDep(String),
    Licenses(String),
    MailType(String),
    MailUser(String),
    McsLabel(String),
    Mem(String),
    MemBind(String),
    MemPerCPU(String),
    MemPerGPU(String),
    MinCPUs(String),
    Network(String),
    Nice(Option<String>),
    NoKill(Option<String>),
    NoRequeue,
    NodeFile(String),
    NodeList(String),
    Nodes(String),
    NTasks(String),
    NTasksPerCore(String),
    NTasksPerGPU(String),
    NTasksPerNode(String),
    NTasksPerSocket(String),
    OOMKillStep(Option<String>),
    OpenMode(String),
    Output(String),
    Overcommit,
    Oversubscribe,
    Parsable,
    Partition(String),
    Prefer(String),
    Priority(String),
    Profile(String),
    Propagate(Option<String>),
    Qos(String),
    Quiet,
    Reboot,
    Requeue,
    Reservation(String),
    ResvPorts(Option<String>),
    Segment(String),
    Signal(String),
    SocketsPerNode(String),
    SpreadJob,
    Stepmgr,
    Switches(String),
    TestOnly,
    ThreadSpec(String),
    ThreadsPerCore(String),
    Time(String),
    TimeMin(String),
    Tmp(String),
    TresBind(String),
    TresPerTask(String),
    UID(String),
    Usage,
    UseMinNodes,
    Verbose,
    Version,
    Wait,
    WaitAllNodes(String),
    WCKey(String),
    Wrap(String),
}

Represents an sbatch option

For a full description of the sbatch options, see the slurm documentation: https://slurm.schedmd.com/sbatch.html The SbatchOption enum variants store Nothing, String, or Option<String> where appropriate. For more complex options, such as --dependency, the helper Dependency struct can be used to format the string.

Variants

Account(String)

AcctgFreq(String)

Array(String)

Batch(String)

Bb(String)

Bbf(String)

Begin(String)

Chdir(String)

ClusterConstraint(String)

Clusters(String)

Comment(String)

Constraint(String)

Container(String)

ContainerID(String)

Contiguous

CoreSpec(String)

CoresPerSocket(String)

CPUFreq(String)

CPUsPerGPU(String)

CPUsPerTask(String)

Deadline(String)

DelayBoot(String)

Dependency(String)

Distribution(String)

Error(String)

Exclude(String)

Exclusive(Option<String>)

Export(String)

ExportFile(String)

Extra(String)

ExtraNodeInfo(String)

GetUserEnv(Option<String>)

GID(String)

GPUBind(String)

GPUFreq(String)

GPUs(String)

GPUsPerNode(String)

GPUsPerSocket(String)

GPUsPerTask(String)

Gres(String)

GresFlags(String)

Help

Hint(String)

Hold

IgnorePbs

Input(String)

JobName(String)

KillOnInvalidDep(String)

Licenses(String)

MailType(String)

MailUser(String)

McsLabel(String)

Mem(String)

MemBind(String)

MemPerCPU(String)

MemPerGPU(String)

MinCPUs(String)

Network(String)

Nice(Option<String>)

NoKill(Option<String>)

NoRequeue

NodeFile(String)

NodeList(String)

Nodes(String)

NTasks(String)

NTasksPerCore(String)

NTasksPerGPU(String)

NTasksPerNode(String)

NTasksPerSocket(String)

OOMKillStep(Option<String>)

OpenMode(String)

Output(String)

Overcommit

Oversubscribe

Parsable

Partition(String)

Prefer(String)

Priority(String)

Profile(String)

Propagate(Option<String>)

Qos(String)

Quiet

Reboot

Requeue

Reservation(String)

ResvPorts(Option<String>)

Segment(String)

Signal(String)

SocketsPerNode(String)

SpreadJob

Stepmgr

Switches(String)

TestOnly

ThreadSpec(String)

ThreadsPerCore(String)

Time(String)

TimeMin(String)

Tmp(String)

TresBind(String)

TresPerTask(String)

UID(String)

Usage

UseMinNodes

Verbose

Version

Wait

WaitAllNodes(String)

WCKey(String)

Wrap(String)

Implementations

impl SbatchOption

pub fn validate(&self) -> Result<(), SbatchOptionError>

Validates the sbatch option.

Returns

This function returns Ok(()) if the sbatch option is valid, otherwise it returns a SbatchOptionError.

Errors

This function returns a SbatchOptionError if the sbatch option is invalid. The following are considered invalid:

• An empty string
• A string that contains leading or trailing spaces

Examples

use sbatch_rs::SbatchOption;

// Valid: mapped to `--account=account`
let sbatch_option = SbatchOption::Account("account".to_string());
assert!(sbatch_option.validate().is_ok());

// Invalid: empty string
let sbatch_option = SbatchOption::Account("".to_string());
assert!(sbatch_option.validate().is_err());

// Invalid: leading or trailing spaces
let sbatch_option = SbatchOption::Account(" account ".to_string());
assert!(sbatch_option.validate().is_err());

Trait Implementations

impl Clone for SbatchOption

fn clone(&self) -> SbatchOption

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SbatchOption

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SbatchOption

fn fmt(&self, f: &mut Formatter<'_>) -> Result

The Display trait is implemented for SbatchOption to allow the SbatchOption to be converted into a string for display purposes.

Example

use sbatch_rs::SbatchOption;

let option = SbatchOption::JobName("test".to_string());
assert_eq!(option.to_string(), "--job-name=test");

impl Hash for SbatchOption

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SbatchOption

fn cmp(&self, other: &SbatchOption) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SbatchOption

fn eq(&self, other: &SbatchOption) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SbatchOption

fn partial_cmp(&self, other: &SbatchOption) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SbatchOption

impl StructuralPartialEq for SbatchOption