Struct TerminateOnDrop

pub struct TerminateOnDrop<O: OutputStream> { /* private fields */ }

A wrapper that automatically terminates a process when dropped.

Safety Requirements

WARNING: This type requires a multithreaded tokio runtime to function correctly!

Usage Guidelines

This type should only be used when:

• Your code is running in a multithreaded tokio runtime.
• Automatic process cleanup on drop is absolutely necessary.

Recommended Alternatives

Instead of relying on automatic termination, prefer these safer approaches:

1. Manual process termination using ProcessHandle::terminate
2. Awaiting process completion using ProcessHandle::wait_for_completion
3. Awaiting process completion or performing an explicit termination using ProcessHandle::wait_for_completion_or_terminate

Implementation Details

The drop implementation tries to terminate the process if it was neither awaited nor terminated before being dropped. If termination fails, a panic is raised.

Methods from Deref<Target = ProcessHandle<O>>

pub fn id(&self) -> Option<u32>

pub fn stdout(&self) -> &O

pub fn stderr(&self) -> &O

Trait Implementations

impl<O: Debug + OutputStream> Debug for TerminateOnDrop<O>

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

Formats the value using the given formatter.

impl<O: OutputStream> Deref for TerminateOnDrop<O>

type Target = ProcessHandle<O>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<O: OutputStream> Drop for TerminateOnDrop<O>

fn drop(&mut self)

Executes the destructor for this type.