tauri-plugin-shell 2.4.1

Access the system shell. Allows you to spawn child processes and manage files and URLs using their default application.
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

// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

use std::path::PathBuf;

use serde::{Serialize, Serializer};

/// Errors returned by the shell plugin.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Failed to invoke the mobile plugin implementation.
    ///
    /// Only available on mobile.
    #[cfg(mobile)]
    #[error(transparent)]
    PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),
    /// I/O error, usually raised when spawning a process or reading its output.
    #[error(transparent)]
    Io(#[from] std::io::Error),
    /// The path of the current executable has no parent directory,
    /// so the path of a sidecar program could not be resolved.
    #[error("current executable path has no parent")]
    CurrentExeHasNoParent,
    /// The string does not match any of the known programs
    /// accepted by the deprecated `open` API.
    #[error("unknown program {0}")]
    UnknownProgramName(String),
    /// The command is not allowed by the configured shell scope.
    #[error(transparent)]
    Scope(#[from] crate::scope::Error),
    /// Sidecar not allowed by the configuration.
    #[error("sidecar not configured under `tauri.conf.json > bundle > externalBin`: {0}")]
    SidecarNotAllowed(PathBuf),
    /// Program not allowed by the scope.
    #[error("program not allowed on the configured shell scope: {0}")]
    ProgramNotAllowed(PathBuf),
    /// The `encoding` spawn option is neither `raw` nor a label of a known character encoding.
    #[error("unknown encoding {0}")]
    UnknownEncoding(String),
    /// JSON error.
    #[error(transparent)]
    Json(#[from] serde_json::Error),
    /// Utf8 error.
    #[error(transparent)]
    Utf8(#[from] std::string::FromUtf8Error),
}

impl Serialize for Error {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self.to_string().as_ref())
    }
}