Struct Pipeline 

pub struct Pipeline { /* private fields */ }

A builder for creating asynchronous command pipelines.

Example

use bare_script::proc::Pipeline;

#[tokio::main]
async fn main() -> Result<(), bare_script::ScriptError> {
    let output = Pipeline::new("echo")
        .arg("hello world")
        .pipe("grep")
        .arg("hello")
        .execute()
        .await?;
     
    assert!(output.success());
    Ok(())
}

Implementations

impl Pipeline

pub fn new<S: AsRef<OsStr>>(program: S) -> Self

Creates a new pipeline starting with the specified program.

pub fn arg<S: AsRef<OsStr>>(self, arg: S) -> Self

Adds an argument to the last command in the pipeline.

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Adds multiple arguments to the last command in the pipeline.

pub fn pipe<S: AsRef<OsStr>>(self, program: S) -> Self

Adds a new command to the pipeline, piping the output of the previous command to the stdin of this command.

pub fn env<K, V>(self, key: K, value: V) -> Self

where K: AsRef<OsStr>, V: AsRef<OsStr>,

Sets an environment variable for all commands in the pipeline.

pub fn current_dir<D>(self, dir: D) -> Self

where D: AsRef<Path>,

Sets the working directory for all commands in the pipeline.

pub fn capture_output(self) -> Self

Configures the pipeline to capture the final output.

pub async fn execute(&mut self) -> ScriptResult<Output>

Executes the pipeline asynchronously and returns the output of the final command.

Note: For async pipelines, commands are executed sequentially, with each command’s stdout passed to the next command’s stdin.

Errors

Returns an error if any command in the pipeline fails to execute.

Trait Implementations

impl Debug for Pipeline

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

Formats the value using the given formatter.

impl Default for Pipeline

fn default() -> Self

Returns the “default value” for a type.