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
81
82
83
84
85
86
87
88
89
90
91
92

//! `system_shutdown` provides a cross platform way to shut down, reboot or log out operations.
//!
//! Supported platforms: Linux, Windows and macOS.
//!
//! # Example
//!
//! The example below shows how to shut down the machine:
//!
//! ```rust
//! use system_shutdown::shutdown;
//!
//! fn main() {
//!     match shutdown() {
//!         Ok(_) => println!("Shutting down, bye!"),
//!         Err(error) => eprintln!("Failed to shut down: {}", error),
//!     }
//! }
//! ```
//!
//! In most of the systems it does not requires the user to be root/admin.

#[cfg(target_os = "linux")]
#[path = "linux.rs"]
mod os;

#[cfg(target_os = "macos")]
#[path = "macos.rs"]
mod os;
#[cfg(target_os = "macos")]
pub use os::request_permission_dialog;

#[cfg(target_os = "windows")]
#[path = "windows.rs"]
mod os;
#[cfg(target_os = "windows")]
pub use os::{reboot_with_message, shutdown_with_message};

use std::io;

#[doc(hidden)]
#[macro_export]
macro_rules! not_implemented {
    () => {
        Err(std::io::Error::new(
            std::io::ErrorKind::Other,
            "feature not implemented yet",
        ))
    };
}

/// A specialized `Result` type for shut down, reboot and log out operations.
pub type ShutdownResult = io::Result<()>;

/// Calls the OS-specific function to shut down the machine.
pub fn shutdown() -> ShutdownResult {
    os::shutdown()
}

/// Calls the OS-specific function to force to shut down the machine.
pub fn force_shutdown() -> ShutdownResult {
    os::force_shutdown()
}

/// Calls the OS-specific function to reboot the machine.
pub fn reboot() -> ShutdownResult {
    os::reboot()
}

/// Calls the OS-specific function to force to reboot the machine.
pub fn force_reboot() -> ShutdownResult {
    os::force_reboot()
}

/// Calls the OS-specific function to log out the user.
pub fn logout() -> ShutdownResult {
    os::logout()
}

/// Calls the OS-specific function to force to log out the user.
pub fn force_logout() -> ShutdownResult {
    os::force_logout()
}

/// Calls the OS-specific function to put the machine to sleep.
pub fn sleep() -> ShutdownResult {
    os::sleep()
}

/// Calls the OS-specific function to hibernate the machine.
pub fn hibernate() -> ShutdownResult {
    os::hibernate()
}