Skip to main content

StdinData

Enum StdinData 

Source
#[non_exhaustive]
pub enum StdinData { Bytes(Vec<u8>), Reader(Box<dyn Read + Send>), }
Expand description

Input data to feed to a child process’s stdin.

Construct via the From impls for bytes/strings, or from_reader / from_async_reader for streaming sources.

§Retry and clone semantics

  • Bytes: owned. If the Cmd is configured to retry, each attempt re-feeds the same bytes (internally the buffer is Arc-shared for cheap clones).
  • Reader: one-shot. The first run attempt consumes the reader; subsequent retries or cloned-then-run attempts see no stdin. Avoid .retry() with a reader unless you understand this.
  • AsyncReader: one-shot like Reader. Only usable on the async path (Cmd::run_async / Cmd::spawn_async). Passing it to the sync runner surfaces a RunError::Spawn with ErrorKind::InvalidInput.

§Picking the right variant for large inputs

For inputs larger than a few MB, the sync Reader variant streams through an OS pipe without buffering the whole thing in memory. On the async path, Reader would require spawn_blocking to drain the sync reader fully into memory before writing — not suitable for gigabyte-sized inputs. Use from_async_reader with a tokio::fs::File or any other AsyncRead source for async streaming.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Bytes(Vec<u8>)

Owned bytes. Reusable across retries.

§

Reader(Box<dyn Read + Send>)

One-shot sync reader. The reader only needs Send; it doesn’t have to be Sync because procpilot hands it to at most one thread at a time (via Arc<Mutex<Option<_>>>).

Implementations§

Source§

impl StdinData

Source

pub fn from_reader<R>(reader: R) -> StdinData
where R: Read + Send + 'static,

Wrap any sync Read source as one-shot streaming stdin.

Trait Implementations§

Source§

impl Debug for StdinData

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&[u8]> for StdinData

Source§

fn from(s: &[u8]) -> StdinData

Converts to this type from the input type.
Source§

impl From<&String> for StdinData

Source§

fn from(s: &String) -> StdinData

Converts to this type from the input type.
Source§

impl From<&Vec<u8>> for StdinData

Source§

fn from(v: &Vec<u8>) -> StdinData

Converts to this type from the input type.
Source§

impl From<&str> for StdinData

Source§

fn from(s: &str) -> StdinData

Converts to this type from the input type.
Source§

impl From<String> for StdinData

Source§

fn from(s: String) -> StdinData

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for StdinData

Source§

fn from(v: Vec<u8>) -> StdinData

Converts to this type from the input type.

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.