Struct NamedCommand 

pub struct NamedCommand<'a> { /* private fields */ }

It’s a command, with a name

This struct allows us to re-name an existing Command via the CommandWithName trait associated functions. When one of those functions such as CommandWithName::named_fn or CommandWithName::named are called, Rust needs somewhere for the new name string to live, so we move it over into this struct which also implements CommandWithName. You can gain access to the original Command reference via CommandWithName::mut_cmd

Trait Implementations

impl CommandWithName for &mut NamedCommand<'_>

fn name(&mut self) -> String

Returns the desired display name of the command

fn mut_cmd(&mut self) -> &mut Command

Returns a reference to &mut Command

fn named(&mut self, s: impl AsRef<str>) -> NamedCommand<'_>

Rename a command via a given string

fn named_fn<'a>( &'a mut self, f: impl FnOnce(&mut Command) -> String, ) -> NamedCommand<'a>

Rename a command via a given function

fn named_output(&mut self) -> Result<NamedOutput, CmdError>

Runs the command without streaming

fn stream_output<OW, EW>( &mut self, stdout_write: OW, stderr_write: EW, ) -> Result<NamedOutput, CmdError>

where OW: Write + Send, EW: Write + Send,

Runs the command and streams to the given writers

impl CommandWithName for NamedCommand<'_>

fn name(&mut self) -> String

Returns the desired display name of the command

fn mut_cmd(&mut self) -> &mut Command

Returns a reference to &mut Command

fn named(&mut self, s: impl AsRef<str>) -> NamedCommand<'_>

Rename a command via a given string

fn named_fn<'a>( &'a mut self, f: impl FnOnce(&mut Command) -> String, ) -> NamedCommand<'a>

Rename a command via a given function

fn named_output(&mut self) -> Result<NamedOutput, CmdError>

Runs the command without streaming

fn stream_output<OW, EW>( &mut self, stdout_write: OW, stderr_write: EW, ) -> Result<NamedOutput, CmdError>

where OW: Write + Send, EW: Write + Send,

Runs the command and streams to the given writers

impl<'a> From<&'a mut Command> for NamedCommand<'a>

fn from(command: &'a mut Command) -> Self

Convert a Command reference into a NamedCommand

Useful to “shorten” a command (to hide additional/unexpected flags).

use fun_run::{NamedCommand, CommandWithName};

let mut command = std::process::Command::new("go");
let mut short: NamedCommand = command
    .args(["list", "-tags", "heroku"])
    .into();

short
    .mut_cmd()
    .args([
        "-f",
        "{{ if eq .Name \"main\" }}{{ .ImportPath }}{{ end }}",
        "./...",
    ]);

// Short name
assert_eq!("go list -tags heroku", &short.name());
// Full args
assert_eq!("go", short.mut_cmd().get_program().to_str().unwrap());
assert_eq!(
    "list -tags heroku -f {{ if eq .Name \"main\" }}{{ .ImportPath }}{{ end }} ./...",
    short
        .mut_cmd()
        .get_args()
        .map(|arg| arg.to_str().unwrap())
        .collect::<Vec<&str>>()
        .join(" ")
);