macros.rs - source
Description: Source of the Rust file `src/macros.rs`.
Keywords: rust, rustlang, rust-lang

    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
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185

    //! # macros
    //!
    //! Defines the library macros
    //!

    /// Enables to invoke the run_script::run function more easily without providing all input.
    ///
    /// # Arguments
    ///
    /// * `script` - The script content
    /// * `args` - Optional, script command line arguments. If provided, the last options argument must also be provided.
    /// * `options` - Optional, options provided to the script runner
    ///
    /// # Examples
    ///
    /// ```rust
    /// use run_script::ScriptOptions;
    ///
    /// fn main() {
    ///     // simple call to run script with only the script text
    ///     let (code, output, error) = run_script::run_script!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#
    ///     ).unwrap();
    ///
    ///     // run script invoked with the script text and options
    ///     let options = ScriptOptions::new();
    ///     let (code, output, error) = run_script::run_script!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#,
    ///         &options
    ///     ).unwrap();
    ///
    ///     // run script invoked with all arguments
    ///     let options = ScriptOptions::new();
    ///     let (code, output, error) = run_script::run_script!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#,
    ///         &vec!["ARG1".to_string(), "ARG2".to_string()],
    ///         &options
    ///     ).unwrap();
    /// }
    /// ```
    #[macro_export]
    macro_rules! run_script {
        ($script:expr) => {{
            let args = vec![];
            let options = $crate::ScriptOptions::new();
            $crate::run(&$script, &args, &options)
        }};
        ($script:expr, $options:expr) => {{
            let args = vec![];
            $crate::run(&$script, &args, &$options)
        }};
        ($script:expr, $args:expr, $options:expr) => {{
            $crate::run(&$script, &$args, &$options)
        }};
    }

    /// Enables to invoke the run_script::spawn function more easily without providing all input.
    ///
    /// # Arguments
    ///
    /// * `script` - The script content
    /// * `args` - Optional, script command line arguments. If provided, the last options argument must also be provided.
    /// * `options` - Optional, options provided to the script runner
    ///
    /// # Examples
    ///
    /// ```rust_script;
    ///
    /// use run_script::ScriptOptions;
    ///
    /// fn main() {
    ///     // simple call to run script with only the script text
    ///     let child = run_script::spawn_script!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#
    ///     ).unwrap();
    ///
    ///     // run script invoked with the script text and options
    ///     let options = ScriptOptions::new();
    ///     let child = run_script::spawn_script!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#,
    ///         &options
    ///     ).unwrap();
    ///
    ///     // run script invoked with all arguments
    ///     let options = ScriptOptions::new();
    ///     let child = run_script::spawn_script!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#,
    ///         &vec!["ARG1".to_string(), "ARG2".to_string()],
    ///         &options
    ///     ).unwrap();
    /// }
    /// ```
    #[macro_export]
    macro_rules! spawn_script {
        ($script:expr) => {{
            let args = vec![];
            let options = $crate::ScriptOptions::new();
            $crate::spawn(&$script, &args, &options)
        }};
        ($script:expr, $options:expr) => {{
            let args = vec![];
            $crate::spawn(&$script, &args, &$options)
        }};
        ($script:expr, $args:expr, $options:expr) => {{
            $crate::spawn(&$script, &$args, &$options)
        }};
    }

    /// Enables to invoke the run_script::run_or_exit function more easily without providing all input.
    ///
    /// # Arguments
    ///
    /// * `script` - The script content
    /// * `args` - Optional, script command line arguments. If provided, the last options argument must also be provided.
    /// * `options` - Optional, options provided to the script runner
    ///
    /// # Examples
    ///
    /// ```rust
    /// use run_script::ScriptOptions;
    ///
    /// fn main() {
    ///     // simple call to the macro with only the script text
    ///     let (output, error) = run_script::run_script_or_exit!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#
    ///     );
    ///
    ///     // macro invoked with the script text and options
    ///     let options = ScriptOptions::new();
    ///     let (output, error) = run_script::run_script_or_exit!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#,
    ///         &options
    ///     );
    ///
    ///     // macro invoked with all arguments
    ///     let options = ScriptOptions::new();
    ///     let (output, error) = run_script::run_script_or_exit!(
    ///         r#"
    ///         echo "Test"
    ///         exit 0
    ///         "#,
    ///         &vec!["ARG1".to_string(), "ARG2".to_string()],
    ///         &options
    ///     );
    /// }
    /// ```
    #[macro_export]
    macro_rules! run_script_or_exit {
        ($script:expr) => {{
            let args = vec![];
            let options = $crate::ScriptOptions::new();
            $crate::run_or_exit(&$script, &args, &options)
        }};
        ($script:expr, $options:expr) => {{
            let args = vec![];
            $crate::run_or_exit(&$script, &args, &$options)
        }};
        ($script:expr, $args:expr, $options:expr) => {{
            $crate::run_or_exit(&$script, &$args, &$options)
        }};
    }