Skip to main content

SimplePipe

Struct SimplePipe 

Source
pub struct SimplePipe { /* private fields */ }
Expand description

A simple pipe that executes a shell command with input on stdin.

§Security Warning

The command string is passed directly to the shell (sh -c on Unix, cmd /C on Windows). If you construct the command from untrusted input, you risk shell injection attacks.

// DANGEROUS if `user_input` is untrusted:
SimplePipe::new(format!("grep {}", user_input))

// SAFE alternatives:
// 1. Use a fixed command string
SimplePipe::new("grep pattern")

// 2. Validate/sanitize user input before interpolation
let sanitized = sanitize_for_shell(user_input);
SimplePipe::new(format!("grep {}", sanitized))

Implementations§

Source§

impl SimplePipe

Source

pub fn new(command: impl Into<String>) -> Self

Create a new pipe that executes the given shell command.

The default mode is PipeMode::Passthrough with a 30-second timeout.

§Security

See the struct-level documentation for shell injection warnings.

Source

pub fn capture(self) -> Self

Use the command’s stdout as the new output.

Source

pub fn consume(self) -> Self

Don’t print anything to the terminal after piping.

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Trait Implementations§

Source§

impl PipeTarget for SimplePipe

Source§

fn pipe(&self, input: &str) -> Result<String, PipeError>

Pipe the input to the target and return the resulting output. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.