Struct nu_system::ForegroundGuard

pub struct ForegroundGuard { /* private fields */ }

Keeps a specific already existing process in the foreground as long as the ForegroundGuard. If the process needs to be spawned in the foreground, use ForegroundChild instead. This is used to temporarily bring plugin processes into the foreground.

OS-specific behavior

Unix

If there is already a foreground external process running, spawned with ForegroundChild, this expects the process ID to remain in the process group created by the ForegroundChild for the lifetime of the guard, and keeps the terminal controlling process group set to that. If there is no foreground external process running, this sets the foreground process group to the plugin’s process ID. The process group that is expected can be retrieved with [.pgrp()] if different from the plugin process ID.

Other systems

It does nothing special on non-unix systems.

Implementations

impl ForegroundGuard

pub fn new( pid: u32, pipeline_state: &Arc<(AtomicU32, AtomicU32)> ) -> Result<ForegroundGuard>

Move the given process to the foreground.

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

If the child process is expected to join a different process group to be in the foreground, this returns Some(pgrp). This only ever returns Some on Unix.

Trait Implementations

impl Debug for ForegroundGuard

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

Formats the value using the given formatter.

impl Drop for ForegroundGuard

fn drop(&mut self)

Executes the destructor for this type.