Struct Sbatch

pub struct Sbatch { /* private fields */ }

sbatch command builder

Examples

use sbatch_rs::{Sbatch, SbatchOption};

// Create a new `Sbatch` instance
let sbatch = Sbatch::new()
    .add_option(SbatchOption::JobName("test".to_string())).unwrap()
    .add_option(SbatchOption::Output("test.out".to_string())).unwrap()
    .add_option(SbatchOption::Error("test.err".to_string())).unwrap()
    .set_script("test.sh".to_string()).unwrap()
    .build();

// Verify that the `sbatch` command was built properly
assert!(sbatch.is_ok());
assert_eq!(sbatch.unwrap(), "sbatch --error=test.err --job-name=test --output=test.out test.sh");

Implementations

impl Sbatch

pub fn new() -> Self

Creates a new Sbatch instance.

Examples

use sbatch_rs::Sbatch;

// Create a new `Sbatch` instance
let sbatch = Sbatch::new();

pub fn add_option( &mut self, option: SbatchOption, ) -> Result<&mut Self, SbatchError>

Adds an SbatchOption to the Sbatch instance.

Arguments

• option - An SbatchOption to add to the Sbatch instance.

Returns

This function returns a mutable reference to the Sbatch instance.

Errors

This function returns a SbatchError if the SbatchOption is invalid.

Examples

use sbatch_rs::{Sbatch, SbatchOption};

// Create a new `Sbatch` instance
let sbatch = Sbatch::new()
    .add_option(SbatchOption::JobName("test".to_string())).unwrap()
    .add_option(SbatchOption::Output("test.out".to_string())).unwrap()
    .add_option(SbatchOption::Error("test.err".to_string())).unwrap()
    .add_option(SbatchOption::Wrap("test".to_string())).unwrap()
    .build();

// Verify that the `sbatch` command was built properly
assert!(sbatch.is_ok());
assert_eq!(sbatch.unwrap(), "sbatch --error=test.err --job-name=test --output=test.out --wrap=\"test\"");

pub fn set_script(&mut self, script: String) -> Result<&mut Self, SbatchError>

Sets the script for the Sbatch instance.

Arguments

• script - A string representing the script to run.

Returns

This function returns a mutable reference to the Sbatch instance.

Errors

This function returns a SbatchError if the script is empty.

Examples

use sbatch_rs::Sbatch;

// Create a new `Sbatch` instance
let sbatch = Sbatch::new()
    .set_script("test.sh".to_string()).unwrap()
    .build();

// Verify that the `sbatch` command was built properly
assert!(sbatch.is_ok());
assert_eq!(sbatch.unwrap(), "sbatch test.sh");

pub fn build(&self) -> Result<String, SbatchError>

Builds the sbatch command.

Returns

This function returns a string representing the sbatch command.

Errors

This function returns a SbatchError if no options or script are provided.

Examples

use sbatch_rs::{Sbatch, SbatchOption};

// Create a new `Sbatch` instance
let sbatch = Sbatch::new()
    .add_option(SbatchOption::JobName("test".to_string())).unwrap()
    .add_option(SbatchOption::Output("test.out".to_string())).unwrap()
    .add_option(SbatchOption::Error("test.err".to_string())).unwrap()
    .set_script("test.sh".to_string()).unwrap()
    .build();
     
// Verify that the `sbatch` command was built properly
assert!(sbatch.is_ok());
assert_eq!(sbatch.unwrap(), "sbatch --error=test.err --job-name=test --output=test.out test.sh");

Trait Implementations

impl Clone for Sbatch

fn clone(&self) -> Sbatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sbatch

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

Formats the value using the given formatter.

impl Default for Sbatch

fn default() -> Self

Creates a default Sbatch instance.

Examples

use sbatch_rs::Sbatch;

// Create a default `Sbatch` instance
let sbatch = Sbatch::default();