open_with 0.1.2

Provides a multiplatform invocation interface to the native open-with interface for files.
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
93
94
95
96
97
98
99
100

use std::error::Error;
use std::path::PathBuf;

#[cfg(target_os = "linux")]
mod lib_linux;
#[cfg(target_os = "linux")]
use lib_linux as backend;

#[cfg(target_os = "macos")]
mod lib_macos;
#[cfg(target_os = "macos")]
use lib_macos as backend;

#[cfg(target_os = "windows")]
mod lib_windows;
#[cfg(target_os = "windows")]
use lib_windows as backend;

/// Opens the file at the given path using the default application.
///
/// # Arguments
///
/// * `file_path` - A `PathBuf` that holds the path to the file to be opened.
///
/// # Errors
///
/// Returns an error if the file cannot be opened.
pub fn open(file_path: PathBuf) -> Result<(), Box<dyn Error>> {
    backend::open(file_path)
}

/// Invokes the platform's "Open With" dialog for the file at the provided path.
///
/// # Arguments
///
/// * `file_path` - A `PathBuf` that holds the path to the file to be opened.
///
/// # Errors
///
/// Returns an error if the file cannot be opened.
pub fn open_with(file_path: PathBuf) -> Result<(), Box<dyn Error>> {
    backend::open_with(file_path)
}

/// Shows the folder containing the file at the given path. Where supported, the file is selected.
///
/// # Arguments
///
/// * `file_path` - A `PathBuf` that holds the path to the file.
///
/// # Errors
///
/// Returns an error if the folder cannot be shown.
pub fn show_in_folder(file_path: PathBuf) -> Result<(), Box<dyn Error>> {
    backend::show_in_folder(file_path)
}

/// Uses the default file manager to show properties of the file at the given path.
///
/// # Arguments
///
/// * `file_path` - A `PathBuf` that holds the path to the file.
///
/// # Errors
///
/// Returns an error if the properties cannot be shown.
pub fn show_properties(file_path: PathBuf) -> Result<(), Box<dyn Error>> {
    backend::show_properties(file_path)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::PathBuf;

    #[test]
    fn test_open() {
        let file_path = PathBuf::from("src/lib.rs");
        let _result = open(file_path).unwrap();
    }

    #[test]
    fn test_open_with() {
        let file_path = PathBuf::from("src/lib.rs");
        let _result = open_with(file_path).unwrap();
    }

    #[test]
    fn test_open_folder() {
        let file_path = PathBuf::from("src/lib.rs");
        let _result = show_in_folder(file_path).unwrap();
    }

    #[test]
    fn test_show_properties() {
        let file_path = PathBuf::from("src/lib.rs");
        let _result = show_properties(file_path).unwrap();
        std::thread::sleep(std::time::Duration::from_millis(10000));
    }
}