Skip to main content

ProcessHandle

Struct ProcessHandle 

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

Handle for driving an interactive or non-interactive process.

This provides a unified interface for both PTY and pipe-based processes:

  • Write to stdin via writer_sender()
  • Read merged stdout/stderr via output_receiver()
  • Check exit status via has_exited() and exit_code()
  • Clean up via terminate()

Implementations§

Source§

impl ProcessHandle

Source

pub fn new( writer_tx: Sender<Vec<u8>>, output_tx: Sender<Vec<u8>>, initial_output_rx: Receiver<Vec<u8>>, killer: Box<dyn ChildTerminator>, reader_handle: JoinHandle<()>, reader_abort_handles: Vec<AbortHandle>, writer_handle: JoinHandle<()>, wait_handle: JoinHandle<()>, exit_status: Arc<AtomicBool>, exit_code: Arc<StdMutex<Option<i32>>>, pty_handles: Option<PtyHandles>, ) -> (Self, Receiver<Vec<u8>>)

Create a new process handle with all required components.

Source

pub fn writer_sender(&self) -> Sender<Vec<u8>>

Returns a channel sender for writing raw bytes to the child stdin.

§Example
let writer = handle.writer_sender();
writer.send(b"input\n".to_vec()).await?;
Source

pub fn output_receiver(&self) -> Receiver<Vec<u8>>

Returns a broadcast receiver that yields stdout/stderr chunks.

Multiple receivers can be created; each receives all output from the point of subscription.

Source

pub fn has_exited(&self) -> bool

True if the child process has exited.

Source

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

Returns the exit code if the process has exited.

Source

pub fn terminate(&self)

Attempts to kill the child and abort helper tasks.

This is idempotent and safe to call multiple times.

Source

pub fn is_running(&self) -> bool

Check if the process is still running.

Source

pub async fn write( &self, bytes: impl Into<Vec<u8>>, ) -> Result<(), SendError<Vec<u8>>>

Send bytes to the process stdin.

Returns an error if the stdin channel is closed.

Source

pub fn is_writer_closed(&self) -> bool

Check if the writer channel is closed.

Trait Implementations§

Source§

impl Debug for ProcessHandle

Source§

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

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

impl Drop for ProcessHandle

Source§

fn drop(&mut self)

Executes the destructor for this type. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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