3030//! ```
3131
3232#[ cfg( target_os = "windows" ) ]
33- pub use windows:: { that , with } ;
33+ use windows as os ;
3434
3535#[ cfg( target_os = "macos" ) ]
36- pub use macos:: { that , with } ;
36+ use macos as os ;
3737
3838#[ cfg( target_os = "ios" ) ]
39- pub use ios:: { that , with } ;
39+ use ios as os ;
4040
4141#[ cfg( any(
4242 target_os = "linux" ,
@@ -47,7 +47,7 @@ pub use ios::{that, with};
4747 target_os = "openbsd" ,
4848 target_os = "solaris"
4949) ) ]
50- pub use unix:: { that , with } ;
50+ use unix as os ;
5151
5252#[ cfg( not( any(
5353 target_os = "linux" ,
@@ -72,13 +72,60 @@ use std::{
7272
7373type Result = io:: Result < ( ) > ;
7474
75- /// Convenience function for opening the passed path in a new thread.
76- /// See documentation of `that(...)` for more details.
75+ /// Open path with the default application.
76+ ///
77+ /// # Examples
78+ ///
79+ /// ```
80+ /// let path = "http://rust-lang.org";
81+ ///
82+ /// match open::that(path) {
83+ /// Ok(()) => println!("Opened '{}' successfully.", path),
84+ /// Err(err) => panic!("An error occurred when opening '{}': {}", path, err),
85+ /// }
86+ /// ```
87+ ///
88+ /// # Errors
89+ ///
90+ /// A [`std::io::Error`] is returned on failure. Because different operating systems
91+ /// handle errors differently it is recommend to not match on a certain error.
92+ pub fn that < T : AsRef < OsStr > + Sized > ( path : T ) -> Result {
93+ os:: that ( path)
94+ }
95+
96+ /// Open path with the given application.
97+ ///
98+ /// # Examples
99+ ///
100+ /// ```
101+ /// let path = "http://rust-lang.org";
102+ /// let app = "firefox";
103+ ///
104+ /// match open::with(path, app) {
105+ /// Ok(()) => println!("Opened '{}' successfully.", path),
106+ /// Err(err) => panic!("An error occurred when opening '{}': {}", path, err),
107+ /// }
108+ /// ```
109+ ///
110+ /// # Errors
111+ ///
112+ /// A [`std::io::Error`] is returned on failure. Because different operating systems
113+ /// handle errors differently it is recommend to not match on a certain error.
114+ pub fn with < T : AsRef < OsStr > + Sized > ( path : T , app : impl Into < String > ) -> Result {
115+ os:: with ( path, app)
116+ }
117+
118+ /// Open path with the default application in a new thread.
119+ ///
120+ /// See documentation of [`that`] for more details.
77121pub fn that_in_background < T : AsRef < OsStr > + Sized > ( path : T ) -> thread:: JoinHandle < Result > {
78122 let path = path. as_ref ( ) . to_os_string ( ) ;
79123 thread:: spawn ( || that ( path) )
80124}
81125
126+ /// Open path with the given application in a new thread.
127+ ///
128+ /// See documentation of [`with`] for more details.
82129pub fn with_in_background < T : AsRef < OsStr > + Sized > (
83130 path : T ,
84131 app : impl Into < String > ,
0 commit comments