Struct piston_rs::Executor

pub struct Executor {
    pub language: String,
    pub version: String,
    pub files: Vec<File>,
    pub stdin: String,
    pub args: Vec<String>,
    pub compile_timeout: isize,
    pub run_timeout: isize,
    pub compile_memory_limit: isize,
    pub run_memory_limit: isize,
}

An object containing information about the code being executed.

A convenient builder flow is provided by the methods associated with the Executor. These consume self and return self for chained calls.

Fields

language: String

Required - The language to use for execution. Defaults to a new String.

version: String

The version of the language to use for execution. Defaults to “*” (most recent version).

files: Vec<File>

Required - A Vector of File’s to send to Piston. The first file in the vector is considered the main file. Defaults to a new Vector.

stdin: String

The text to pass as stdin to the program. Defaults to a new String.

args: Vec<String>

The arguments to pass to the program. Defaults to a new Vector.

compile_timeout: isize

The maximum allowed time for compilation in milliseconds. Defaults to 10,000.

run_timeout: isize

The maximum allowed time for execution in milliseconds. Defaults to 3,000.

compile_memory_limit: isize

The maximum allowed memory usage for compilation in bytes. Defaults to -1 (no limit).

run_memory_limit: isize

The maximum allowed memory usage for execution in bytes. Defaults to -1 (no limit).

Implementations

impl Executor

pub fn new() -> Self

Creates a new executor representing source code to be executed.

Metadata regarding the source language and files will need to be added using the associated method calls, and other optional fields can be set as well.

Returns

• Executor - The new blank Executor.

Example

let executor = piston_rs::Executor::new();

assert_eq!(executor.language, String::new());
assert_eq!(executor.version, String::from("*"));

pub fn reset(&mut self)

Resets the executor back to a new state, ready to be configured again and sent to Piston after metadata is added. This method mutates the existing executor in place.

Example

let mut executor = piston_rs::Executor::new()
    .set_language("rust");

assert_eq!(executor.language, "rust".to_string());

executor.reset();

assert_eq!(executor.language, String::new());

pub fn set_language(self, language: &str) -> Self

Sets the language to use for execution.

Arguments

• language - The language to use.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .set_language("rust");

assert_eq!(executor.language, "rust".to_string());

pub fn set_version(self, version: &str) -> Self

Sets the version of the language to use for execution.

Arguments

• version - The version to use.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .set_version("1.50.0");

assert_eq!(executor.version, "1.50.0".to_string());

pub fn add_file(self, file: File) -> Self

Adds a File containing the code to be executed. Does not overwrite any existing files.

Arguments

• file - The file to add.

Returns

• Self - For chained method calls.

Example

let file = piston_rs::File::default();

let executor = piston_rs::Executor::new()
    .add_file(file.clone());

assert_eq!(executor.files, [file].to_vec());

pub fn add_files(self, files: Vec<File>) -> Self

Adds multiple File’s containing the code to be executed. Does not overwrite any existing files.

Arguments

• files - The files to add.

Returns

• Self - For chained method calls.

Example

let mut files = vec![];

for _ in 0..3 {
    files.push(piston_rs::File::default());
}

let executor = piston_rs::Executor::new()
    .add_files(files.clone());

assert_eq!(executor.files, files);

pub fn set_files(&mut self, files: Vec<File>)

Adds multiple File’s containing the code to be executed. Overwrites any existing files. This method mutates the existing executor in place. Overwrites any existing files.

Arguments

• files - The files to replace existing files with.

Example

let old_file = piston_rs::File::default()
    .set_name("old_file.rs");

let mut executor = piston_rs::Executor::new()
    .add_file(old_file.clone());

assert_eq!(executor.files.len(), 1);
assert_eq!(executor.files[0].name, "old_file.rs".to_string());

let new_files = vec![
    piston_rs::File::default().set_name("new_file1.rs"),
    piston_rs::File::default().set_name("new_file2.rs"),
];

executor.set_files(new_files.clone());

assert_eq!(executor.files.len(), 2);
assert_eq!(executor.files[0].name, "new_file1.rs".to_string());
assert_eq!(executor.files[1].name, "new_file2.rs".to_string());

pub fn set_stdin(self, stdin: &str) -> Self

Sets the text to pass as stdin to the program.

Arguments

• stdin - The text to set.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .set_stdin("Fearless concurrency");

assert_eq!(executor.stdin, "Fearless concurrency".to_string());

pub fn add_arg(self, arg: &str) -> Self

Adds an arg to be passed as a command line argument. Does not overwrite any existing args.

Arguments

• arg - The arg to add.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .add_arg("--verbose");

assert_eq!(executor.args, vec!["--verbose".to_string()]);

pub fn add_args(self, args: Vec<&str>) -> Self

Adds multiple args to be passed as a command line arguments. Does not overwrite any existing args.

Arguments

• args - The args to add.

Example

let executor = piston_rs::Executor::new()
    .add_args(vec!["--verbose"]);

assert_eq!(executor.args, vec!["--verbose".to_string()]);

pub fn set_args(&mut self, args: Vec<&str>)

Adds multiple args to be passed as a command line arguments. Overwrites any existing args. This method mutates the existing executor in place. Overwrites any existing args.

Arguments

• args - The args to replace existing args with.

Example

let mut executor = piston_rs::Executor::new()
    .add_arg("--verbose");

assert_eq!(executor.args.len(), 1);
assert_eq!(executor.args[0], "--verbose".to_string());

let args = vec!["commit", "-S"];
executor.set_args(args);

assert_eq!(executor.args.len(), 2);
assert_eq!(executor.args[0], "commit".to_string());
assert_eq!(executor.args[1], "-S".to_string());

pub fn set_compile_timeout(self, timeout: isize) -> Self

Sets the maximum allowed time for compilation in milliseconds.

Arguments

• timeout - The timeout to set.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .set_compile_timeout(5000);

assert_eq!(executor.compile_timeout, 5000);

pub fn set_run_timeout(self, timeout: isize) -> Self

Sets the maximum allowed time for execution in milliseconds.

Arguments

• timeout - The timeout to set.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .set_run_timeout(1500);

assert_eq!(executor.run_timeout, 1500);

pub fn set_compile_memory_limit(self, limit: isize) -> Self

Sets the maximum allowed memory usage for compilation in bytes.

Arguments

• limit - The memory limit to set.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .set_compile_memory_limit(100_000_000);

assert_eq!(executor.compile_memory_limit, 100_000_000);

pub fn set_run_memory_limit(self, limit: isize) -> Self

Sets the maximum allowed memory usage for execution in bytes.

Arguments

• limit - The memory limit to set.

Returns

• Self - For chained method calls.

Example

let executor = piston_rs::Executor::new()
    .set_run_memory_limit(100_000_000);

assert_eq!(executor.run_memory_limit, 100_000_000);

Trait Implementations

impl Clone for Executor

fn clone(&self) -> Executor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Executor

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

Formats the value using the given formatter.

impl Default for Executor

fn default() -> Self

Creates a new executor. Alias for Executor::new.

Returns

• Executor - The new blank Executor.

Example

let executor = piston_rs::Executor::default();

assert_eq!(executor.language, String::new());
assert_eq!(executor.version, String::from("*"));

impl<'de> Deserialize<'de> for Executor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Executor

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

Serialize this value into the given Serde serializer.