Skip to main content

SubprocessHandle

Struct SubprocessHandle 

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

Handle to a running subprocess with streaming output capture.

Implementations§

Source§

impl SubprocessHandle

Source

pub async fn cancel(&mut self) -> Result<()>

Cancel the subprocess by sending SIGTERM, then SIGKILL if needed.

Source

pub fn try_recv_stdout(&mut self) -> Option<OutputLine>

Try to receive the next stdout line without blocking.

Source

pub fn try_recv_stderr(&mut self) -> Option<OutputLine>

Try to receive the next stderr line without blocking.

Source

pub fn is_running(&self) -> bool

Returns true if the subprocess is still running.

Source

pub fn exit_code(&self) -> Option<i32>

Returns the exit code if the subprocess has finished.

Source

pub fn is_timed_out(&self) -> bool

Check if the subprocess has exceeded its timeout (synchronous check). This does not kill the process; it only checks the elapsed time.

Source

pub fn try_poll_exit(&mut self) -> bool

Non-blocking check if the subprocess has exited. If it has, sets finished and exit_code and returns true. This allows synchronous tick loops to detect completion.

Source

pub async fn check_timeout(&mut self) -> bool

Check if the subprocess has exceeded its timeout. Returns true if timed out (and kills the process).

Source

pub async fn wait(&mut self) -> Result<i32>

Wait for the subprocess to complete and return its exit code.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more