Struct Command

pub struct Command { /* private fields */ }

A process builder for elevated execution

Implementations

impl Command

The Command type acts as a process builder for spawning programs that run in an elevated context.

Example:

use runas::Command;
let status = Command::new("cmd").status();

pub fn new<S: AsRef<OsStr>>(program: S) -> Command

Creates a new command type for a given program.

The default configuration is to spawn without arguments, to be visible and to not be launched from a GUI context.

Examples found in repository

examples/cmd.rs (line 18)

fn main() {
    println!("Starting a root shell:");
    println!(
        "Status: {}",
        runas::Command::new(shell())
            .status()
            .expect("failed to execute")
    );
}

examples/demo.rs (line 24)

fn main() {
    println!("Running id");
    println!(
        "Status: {}",
        runas::Command::new("id")
            .gui(false)
            .force_prompt(false)
            .status()
            .expect("failed to execute")
    );
}

pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Command

Add an argument to pass to the program.

pub fn args<S: AsRef<OsStr>>(&mut self, args: &[S]) -> &mut Command

Add multiple arguments to pass to the program.

pub fn show(&mut self, val: bool) -> &mut Command

Controls the visibility of the program on supported platforms. The default is to launch the program visible.

pub fn gui(&mut self, val: bool) -> &mut Command

Controls the GUI context. The default behavior is to assume that the program is launched from a command line (not using a GUI). This primarily controls how the elevation prompt is rendered. On some platforms like Windows the elevation prompt is always a GUI element.

If the preferred mode is not available it falls back to the other automatically.

Examples found in repository

examples/demo.rs (line 25)

fn main() {
    println!("Running id");
    println!(
        "Status: {}",
        runas::Command::new("id")
            .gui(false)
            .force_prompt(false)
            .status()
            .expect("failed to execute")
    );
}

pub fn force_prompt(&mut self, val: bool) -> &mut Command

Can disable the prompt forcing for supported platforms. Mostly this allows sudo on unix platforms to not prompt for a password.

Examples found in repository

examples/demo.rs (line 26)

fn main() {
    println!("Running id");
    println!(
        "Status: {}",
        runas::Command::new("id")
            .gui(false)
            .force_prompt(false)
            .status()
            .expect("failed to execute")
    );
}

pub fn status(&mut self) -> Result<ExitStatus>

Executes a command as a child process, waiting for it to finish and collecting its exit status.

Examples found in repository

examples/cmd.rs (line 19)

fn main() {
    println!("Starting a root shell:");
    println!(
        "Status: {}",
        runas::Command::new(shell())
            .status()
            .expect("failed to execute")
    );
}

examples/demo.rs (line 27)

fn main() {
    println!("Running id");
    println!(
        "Status: {}",
        runas::Command::new("id")
            .gui(false)
            .force_prompt(false)
            .status()
            .expect("failed to execute")
    );
}