system_shutdown 4.1.0

Rust library for shut down, reboot or log out operations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

use std::fs::File;
use std::io::{Error, ErrorKind, Write};
use std::process::Command;

use super::not_implemented;
use super::ShutdownResult;

fn invoke_script(script: &str) -> ShutdownResult {
    let mut cmd = Command::new("osascript");
    cmd.args(&["-e", script]);
    match cmd.output() {
        Ok(output) => {
            if output.status.success() && output.stderr.is_empty() {
                return Ok(());
            }
            Err(Error::new(
                ErrorKind::Other,
                String::from_utf8(output.stderr).unwrap(),
            ))
        }
        Err(error) => Err(error),
    }
}

/// macOS requires to explicitly allow the application to call "System Events". If you want to use this crate in an unattended way (automation etc.),
/// you may want to ask for permission beforehand to allow this app to call "System Events".
/// This function requests the "System Events" to "stop current screen saver", which should be a fairly safe operation.
pub fn request_permission_dialog() -> ShutdownResult {
    invoke_script("tell application \"System Events\" to stop current screen saver")
}

/// macOS specific function to shut down the system using AppleScript and "System Events" call "shut down"
/// First time you use this, macOS will ask for a permission. If you want to ask for a permission beforehand, use [`request_permission_dialog`]
pub fn shutdown() -> ShutdownResult {
    invoke_script("tell application \"System Events\" to shut down")
}

#[doc(hidden)]
pub fn force_shutdown() -> ShutdownResult {
    not_implemented!()
}

/// macOS specific function to reboot using AppleScript and "System Events" call "restart"
/// First time you use this, macOS will ask for a permission. If you want to ask for a permission beforehand, use [`request_permission_dialog`]
pub fn reboot() -> ShutdownResult {
    invoke_script("tell application \"System Events\" to restart")
}

/// Unix specific function to force reboot the machine using the magic SysRq key.
pub fn force_reboot() -> ShutdownResult {
    // Reference: https://www.kernel.org/doc/html/latest/admin-guide/sysrq.html
    let mut file = File::create("/proc/sys/kernel/sysrq")?;
    file.write_all(b"128")?;
    file = File::create("/proc/sysrq-trigger")?;
    file.write_all(b"b")?;
    Ok(())
}

/// macOS specific function to logout with a confirmation dialog using AppleScript and "System Events" call "log out".
/// First time you use this, macOS will ask for a permission. If you want to ask for a permission beforehand, use [`request_permission_dialog`]
pub fn logout() -> ShutdownResult {
    invoke_script("tell application \"System Events\" to log out")
}

/// macOS specific function to force logout without showing a confirmation dialog using AppleScript and "loginwindow" call "«event aevtrlgo»"
pub fn force_logout() -> ShutdownResult {
    invoke_script("tell application \"loginwindow\" to «event aevtrlgo»")
}

/// macOS specific function to put the machine to sleep using AppleScript and "System Events" call "sleep"
/// First time you use this, macOS will ask for a permission. If you want to ask for a permission beforehand, use [`request_permission_dialog`]
pub fn sleep() -> ShutdownResult {
    invoke_script("tell application \"System Events\" to sleep")
}

#[doc(hidden)]
pub fn hibernate() -> ShutdownResult {
    // It's possible but not generally a good idea https://superuser.com/a/630985
    not_implemented!()
}