Struct SpawnOptions 

pub struct SpawnOptions<'a> { /* private fields */ }

Capabilities and policy needed only for one spawn operation.

Jobs are retained in call order, from the root Job to the innermost Job. The options borrow every capability; they never assume ownership of a Job, parent process, or pseudoconsole.

The borrow cannot escape the capability it protects:

use windows_spawn::{Command, Job, SpawnOptions};

let options;
{
    let job = Job::create().unwrap();
    options = SpawnOptions::new().job(&job);
}
Command::new("cmd.exe").spawn_with(options).unwrap();

Implementations

impl<'a> SpawnOptions<'a>

pub fn new() -> Self

Creates default per-spawn options.

Examples found in repository

examples/managed_output.rs (line 11)

fn main() -> std::io::Result<()> {
    use windows_spawn::{Command, DropPolicy, SpawnOptions};

    let mut command = Command::new(r"C:\Windows\System32\cmd.exe");
    command
        .args(["/D", "/S", "/C"])
        .raw_arg("echo managed output");
    let output = command.output_with(SpawnOptions::new().drop_policy(DropPolicy::KillTree))?;

    assert!(output.status.success());
    print!("{}", String::from_utf8_lossy(&output.stdout));
    Ok(())
}

pub fn job(self, job: &'a Job) -> Self

Appends a Job, preserving root-to-inner ordering.

pub fn parent_process(self, parent: &'a ParentProcess) -> Self

Chooses another process as the logical parent.

pub const fn mitigation(self, mitigation: MitigationPolicy) -> Self

Applies a process-creation mitigation policy.

pub fn pseudoconsole<T: AsPseudoConsole>(self, pseudoconsole: &'a T) -> Self

Attaches the child to a borrowed pseudoconsole.

pub const fn creation_flags(self, flags: CreationFlags) -> Self

Adds named process-creation flags.

pub const fn drop_policy(self, policy: DropPolicy) -> Self

Chooses the live-child drop policy.

Examples found in repository

examples/managed_output.rs (line 11)

fn main() -> std::io::Result<()> {
    use windows_spawn::{Command, DropPolicy, SpawnOptions};

    let mut command = Command::new(r"C:\Windows\System32\cmd.exe");
    command
        .args(["/D", "/S", "/C"])
        .raw_arg("echo managed output");
    let output = command.output_with(SpawnOptions::new().drop_policy(DropPolicy::KillTree))?;

    assert!(output.status.success());
    print!("{}", String::from_utf8_lossy(&output.stdout));
    Ok(())
}

Trait Implementations

impl Debug for SpawnOptions<'_>

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

Formats the value using the given formatter.

impl Default for SpawnOptions<'_>

fn default() -> Self

Returns the “default value” for a type.