Struct Runner

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

Available on crate feature os_cmd only.

Command runner with configurable preprocessing and execution strategies

Implementations

impl<'a> Runner<'a>

pub fn with_command(self, val: CommandRepr<'a>) -> Self

Command representation (raw string or pre-split slices)

pub fn with_remove_comments(self, val: bool) -> Self

Flag to remove // comments from command strings

pub fn with_eprint_cmd(self, val: bool) -> Self

Directly print command to stderr before execution

pub fn with_log_dbg_cmd(self, val: bool) -> Self

Log command via log::debug!()

impl<'a> Runner<'a>

pub fn get_command(&self) -> &CommandRepr<'a>

Command representation (raw string or pre-split slices)

pub fn get_remove_comments(&self) -> &bool

Flag to remove // comments from command strings

pub fn get_eprint_cmd(&self) -> &bool

Directly print command to stderr before execution

pub fn get_log_dbg_cmd(&self) -> &bool

Log command via log::debug!()

impl Runner<'_>

pub fn run(self) -> Result<()>

Executes command with configured preprocessing

Example

use tap::Pipe;
use testutils::{
  get_pkg_name,
  os_cmd::{Runner, presets::CargoDoc},
};

CargoDoc::default()
  .with_pkg(get_pkg_name!())
  .pipe(Runner::from)
  .run()

impl Runner<'_>

pub fn collect_raw( raw: &str, remove_comments: bool, ) -> TinyVec<[Cow<'_, str>; 16]>

Parses raw command string into executable components

Why TinyVec:

• Stack-allocated for small commands (≤16 elements)
• Fallback to heap for large commands automatically

size: TinyVec<[Cow<'_, str>; 16]> = 392

Trait Implementations

impl<'a> Clone for Runner<'a>

fn clone(&self) -> Runner<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Runner<'a>

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

Formats the value using the given formatter.

impl Default for Runner<'_>

fn default() -> Self

Default:

Runner {
    command: Raw("cargo"),
    remove_comments: true,
    eprint_cmd: true,
    log_dbg_cmd: false,
}

Why these defaults:

• remove_comments: true => Safer execution by default
• eprint_cmd: true => Immediate visibility of executed command
• log_dbg_cmd: false => Avoid duplicate logging unless requested

impl<'a> From<&'a str> for Runner<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<Box<[&'a str]>> for Runner<'a>

fn from(value: Box<[&'a str]>) -> Self

Converts to this type from the input type.

impl From<Box<[CompactString]>> for Runner<'_>

fn from(value: Box<[MiniStr]>) -> Self

Converts to this type from the input type.

impl From<CargoCmd> for Runner<'_>

fn from(value: CargoCmd) -> Self

Converts to this type from the input type.

impl<'a> From<CargoDoc<'a>> for Runner<'a>

fn from(value: CargoDoc<'a>) -> Self

Converts to this type from the input type.

impl From<CargoFmt> for Runner<'_>

fn from(value: CargoFmt) -> Self

Converts to this type from the input type.

impl<'a> From<CommandRepr<'a>> for Runner<'a>

Conversion trait implementation

fn from(command: CommandRepr<'a>) -> Self

Converts to this type from the input type.

impl From<Vec<CompactString>> for Runner<'_>

fn from(value: Vec<MiniStr>) -> Self

Converts to this type from the input type.

impl<'a> RunnableCommand<'a> for Runner<'a>

fn run(self) -> Result<()>