Struct Script 

pub struct Script { /* private fields */ }

Script represents a single script.

It requires at least to set a scripting language and content. Script’s arguments and options are optional. ScriptingLanguage defines the language in which the script is implemented. Currently, library supports 8 most popular scripting languages, but it is possible to support a custom ones via ScriptingLanguage::Other.

Script stores its content in a file and then executes Cmd provided by Runnable trait implementation.

Implementations

impl Script

pub fn new<S>(lang: ScriptingLanguage, content: S) -> Self

where S: Into<String>,

Creates a new script with given scripting language and content.

Examples

Script::new(ScriptingLanguage::Bash, r#"
    user=$(echo $USER)
    echo "Hello $user"
"#);

pub fn with_args<S, T, I>(lang: ScriptingLanguage, content: S, args: I) -> Self

where S: Into<String>, T: Into<String>, I: IntoIterator<Item = T>,

Creates a new script with given scripting language, content and arguments.

Examples

Script::with_args(ScriptingLanguage::Bash, "echo $@ | cut -d ' ' -f2", ["arg1", "arg2"]);

pub fn with_options<S>( lang: ScriptingLanguage, content: S, options: CmdOptions, ) -> Self

where S: Into<String>,

Creates a new script with given scripting language, content and options.

Examples

let content = r#"
    for dir in "$(ls -d */)"; do
       echo "$dir"
    done
"#;
let options = CmdOptions::with_logging(LoggingType::StdoutOnly);
Script::with_options(ScriptingLanguage::Bash, content, options);

pub fn with_args_and_options<S, T, I>( lang: ScriptingLanguage, content: S, args: I, options: CmdOptions, ) -> Self

where S: Into<String>, T: Into<String>, I: IntoIterator<Item = T>,

Creates a new script with given scripting language, content, arguments and options.

Examples

let content = r#"
    base_dir="$1"
    for dir in "$(ls -d $base_dir/*/)"; do
        echo "$dir"
    done
"#;
let args = vec!["/some/path"];
let options = CmdOptions::with_logging(LoggingType::StdoutOnly);
Script::with_args_and_options(ScriptingLanguage::Bash, content, args, options);

pub fn set_args<S, I>(&mut self, args: I)

where S: Into<String>, I: IntoIterator<Item = S>,

Set a script arguments.

Examples

let mut script = Script::new(ScriptingLanguage::Bash, "echo $@ | cut -d ' ' -f2");
script.set_args(["arg1", "arg2"]);

pub fn set_options(&mut self, options: CmdOptions)

Set a script options.

Examples

let mut script = Script::new(ScriptingLanguage::Bash, "echo $@ | cut -d ' ' -f2");
script.set_options(CmdOptions::with_standard_io_messaging());

pub fn add_arg<S>(&mut self, arg: S)

where S: Into<String>,

Add a new argument to the end of argument list. If arguments was not specified during Script creation, it will create new argument list with given argument.

Examples

let mut script = Script::new(ScriptingLanguage::Bash, "echo $@ | cut -d ' ' -f2");
script.add_arg("arg1");
script.add_arg("arg2");

pub fn language(&self) -> &ScriptingLanguage

Get script language.

pub fn content(&self) -> &str

Get script content.

pub fn args(&self) -> &[String]

Get script arguments.

pub fn options(&self) -> &CmdOptions

Get script options.

pub fn options_mut(&mut self) -> &mut CmdOptions

Update script options via mutable reference.

Examples

let mut script = Script::new(ScriptingLanguage::Bash, "echo $TEST_ENV_VAR | cut -d ' ' -f2");
script.options_mut().add_env("TEST_ENV_VAR", "example value");

Trait Implementations

impl Clone for Script

fn clone(&self) -> Script

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Script

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Script

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Script

fn eq(&self, other: &Script) -> 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 Runnable for Script

fn bootstrap_cmd(&self, process_dir: &Path) -> Result<Cmd, String>

This method should prepare process to run and return Cmd used to spawn a custom process. If you need to create some files for properly spawning a process, do it inside provided process_dir directory.

fn clean_after_fail(&self, process_dir: &Path) -> Result<(), String>

This method is called when process spawning fails. Notice that process_dir will be deleted automatically, so there is no need to delete it here.

impl Serialize for Script

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Script

impl StructuralPartialEq for Script