Struct command_error::ChildContext

pub struct ChildContext<C> { /* private fields */ }

A Child process combined with context about the Command that produced it.

The context information stored in this type is used to produce diagnostics in ChildExt.

See: OutputContext.

Implementations

impl<C> ChildContext<C>

pub fn into_child(self) -> C

Get the child process.

pub fn child(&self) -> &C

Get a reference to the child process.

pub fn child_mut(&mut self) -> &mut C

Get a mutable reference to the child process.

pub fn command(&self) -> &(dyn CommandDisplay + Send + Sync)

Get a reference to the command which produced this child process.

Trait Implementations

impl ChildExt for ChildContext<Child>

type Error = Error

The error type returned from methods on this trait.

fn output_checked_as<O, R, E>( self, succeeded: impl Fn(OutputContext<O>) -> Result<R, E> ) -> Result<R, E>

where O: Debug + OutputLike + 'static + TryFrom<Output>, <O as TryFrom<Output>>::Error: Display + Send + Sync, E: From<Self::Error>,

Wait for the process to complete, capturing its output. succeeded is called and returned to determine if the command succeeded.

fn try_wait_checked_as<R, E>( &mut self, succeeded: impl Fn(TryWaitContext) -> Result<R, E> ) -> Result<R, E>

where E: From<Self::Error>,

Check if the process has exited.

fn wait_checked_as<R, E>( &mut self, succeeded: impl Fn(OutputContext<ExitStatus>) -> Result<R, E> ) -> Result<R, E>

where E: From<Self::Error>,

Wait for the process to exit. succeeded is called and returned to determine if the command succeeded.

fn log(&self) -> Result<(), Self::Error>

Log the command that will be run.

fn output_checked_with<O, E>( self, succeeded: impl Fn(&O) -> Result<(), Option<E>> ) -> Result<O, Self::Error>

where O: Debug + OutputLike + TryFrom<Output> + Send + Sync + 'static, <O as TryFrom<Output>>::Error: Display + Send + Sync, E: Debug + Display + Send + Sync + 'static,

Wait for the process to complete, capturing its output. succeeded is called and used to determine if the command succeeded and (optionally) to add an additional message to the error returned.

fn output_checked(self) -> Result<Output, Self::Error>

Wait for the process to complete, capturing its output. If the command exits with a non-zero exit code, an error is raised.

fn output_checked_utf8(self) -> Result<Utf8Output, Self::Error>

Wait for the process to exit, capturing its output and decoding it as UTF-8. If the command exits with a non-zero exit code, an error is raised.

fn output_checked_with_utf8<E>( self, succeeded: impl Fn(&Utf8Output) -> Result<(), Option<E>> ) -> Result<Utf8Output, Self::Error>

where E: Display + Debug + Send + Sync + 'static,

Wait for the process to exit, capturing its output and decoding it as UTF-8. succeeded is called and used to determine if the command succeeded and (optionally) to add an additional message to the error returned.

fn try_wait_checked(&mut self) -> Result<Option<ExitStatus>, Self::Error>

Check if the process has exited and, if it failed, return an error.

fn wait_checked_with<E>( &mut self, succeeded: impl Fn(ExitStatus) -> Result<(), Option<E>> ) -> Result<ExitStatus, Self::Error>

where E: Debug + Display + Send + Sync + 'static,

Wait for the process to exit. succeeded is called and used to determine if the command succeeded and (optionally) to add an additional message to the error returned.

fn wait_checked(&mut self) -> Result<ExitStatus, Self::Error>

Wait for the process to exit. If the command exits with a non-zero status code, an error is raised containing information about the command that was run.

impl<C> Debug for ChildContext<C>

where C: Debug,

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

Formats the value using the given formatter.