lock 0.1.0

Lock your system. Supports macOS, Linux, and Windows.
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

#[cfg(target_os = "macos")]
mod macos;
#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "windows")]
mod windows;

#[cfg(target_os = "macos")]
use macos::lock_sytem;
#[cfg(target_os = "linux")]
use linux::lock_sytem;
#[cfg(target_os = "windows")]
use windows::lock_sytem;

/// FailureReason enum for posible failures.
pub enum FailureReason {
    /// Lock command execution failure.
    CannotExecute,
    /// No applicable command found for Linux.
    /// This crate supports 3 following Linux commands:
    ///  - xdg-screensaver,
    ///  - gnome-screensaver,
    ///  - dm-tool.
    LinuxCommandNotFound,
}

/// Locks the system.
/// Returns
///  - FailureReason::LinuxCommandNotFound if there is no command to lock,
///  - FailureReason::CannotExecute if command execution is failed.
pub fn lock() -> Result<(), FailureReason> {
    lock_sytem()
}