openrunner-rs 1.0.0

A Rust library for running OpenScript
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! Convenience macros for OpenRunner script execution.
//!
//! This module provides ergonomic macros that simplify common script execution patterns.

/// Run OpenScript code with optional configuration.
///
/// This macro provides a convenient way to run OpenScript code with either default
/// options or custom configuration.
///
/// # Examples
///
/// ```rust
/// use openrunner_rs::{run_script, ScriptOptions};
/// use std::time::Duration;
///
/// # #[tokio::main]
/// # async fn main() -> openrunner_rs::Result<()> {
/// // Run with default options. This assumes `openscript` is in the PATH.
/// // let result = run_script!("echo 'Hello from default openscript!'").await?;
///
/// // Run with custom options (shell for testing)
/// let options = ScriptOptions::new().openscript_path("/bin/sh");
/// let result = run_script!("echo 'Hello, World!'", options).await?;
///
/// // Run with additional configuration
/// let options = ScriptOptions::new()
///     .openscript_path("/bin/sh")
///     .timeout(Duration::from_secs(30));
/// let result = run_script!("echo 'Hello, World!'", options).await?;
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! run_script {
    ($script:expr) => {
        $crate::run($script, $crate::ScriptOptions::default())
    };
    ($script:expr, $options:expr) => {
        $crate::run($script, $options)
    };
}

/// Spawn an OpenScript process with optional configuration.
///
/// This macro provides a convenient way to spawn OpenScript processes without
/// waiting for completion.
///
/// # Examples
///
/// ```rust
/// use openrunner_rs::{spawn_script, ScriptOptions};
///
/// # #[tokio::main]
/// # async fn main() -> openrunner_rs::Result<()> {
/// // Spawn with default options. This assumes `openscript` is in the PATH.
/// // let child = spawn_script!("echo 'Background task'").await?;
///
/// // Spawn with custom options (shell for testing)
/// let options = ScriptOptions::new().openscript_path("/bin/sh");
/// let spawn_result = spawn_script!("echo 'Background task'", options).await?;
///
/// // Spawn with additional configuration
/// let options = ScriptOptions::new()
///     .openscript_path("/bin/sh")
///     .env("DEBUG", "1");
/// let spawn_result_2 = spawn_script!("echo 'Background task'", options).await?;
///
/// // Wait for completion
/// let output = spawn_result.child.wait_with_output().await?;
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! spawn_script {
    ($script:expr) => {
        $crate::spawn($script, $crate::ScriptOptions::default())
    };
    ($script:expr, $options:expr) => {
        $crate::spawn($script, $options)
    };
}

/// Run an OpenScript file with optional configuration.
///
/// This macro provides a convenient way to run OpenScript files with either
/// default options or custom configuration.
///
/// # Examples
///
/// ```rust
/// use openrunner_rs::{run_file_script, ScriptOptions};
/// use std::path::PathBuf;
///
/// # #[tokio::main]
/// # async fn main() -> openrunner_rs::Result<()> {
/// # use std::io::Write;
/// # let mut file = tempfile::NamedTempFile::new().unwrap();
/// # writeln!(file, "echo 'test'").unwrap();
/// # let script_path = file.path().to_path_buf();
///
/// // Run with default options. This assumes `openscript` is in the PATH.
/// // let result = run_file_script!(&script_path).await?;
///
/// // Run with custom options (shell for testing)
/// let options = ScriptOptions::new().openscript_path("/bin/sh");
/// let result = run_file_script!(&script_path, options).await?;
///
/// // Run with additional configuration
/// let options = ScriptOptions::new()
///     .openscript_path("/bin/sh")
///     .env("MODE", "production");
/// let result = run_file_script!(&script_path, options).await?;
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! run_file_script {
    ($path:expr) => {
        $crate::run_file($path, $crate::ScriptOptions::default())
    };
    ($path:expr, $options:expr) => {
        $crate::run_file($path, $options)
    };
}