bp3d_os/open/
error.rs

1// Copyright (c) 2023, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use std::fmt::{Display, Formatter};
30
31/// Error cases for open functions.
32#[derive(Debug)]
33pub enum Error {
34    /// An IO error.
35    ///
36    /// This error typically occurs when the URL object failed to create its OsString
37    /// representation or when getting the absolute path of a file.
38    Io(std::io::Error),
39
40    /// The current platform does not support this operation.
41    ///
42    /// This error may be thrown for example, when calling show_in_files on iOS or on Windows.
43    /// Another case is when [open](super::open) is called with a web page on a Linux system with no
44    /// xdg-open script/binary present in the PATH.
45    Unsupported,
46
47    /// Another kind of system error.
48    ///
49    /// This variant is typically returned in case of DBus error under non Apple/Android unix
50    /// systems.
51    Other(String),
52}
53
54/// The result type of an open operation.
55pub type Result = std::result::Result<(), Error>;
56
57impl Display for Error {
58    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
59        match self {
60            Error::Io(e) => write!(f, "io error: {}", e),
61            Error::Unsupported => f.write_str("unsupported operation"),
62            Error::Other(e) => write!(f, "other OS error: {}", e),
63        }
64    }
65}
66
67impl std::error::Error for Error {}
bp3d_os/open/error.rs

bp3d_os/open/
error.rs
