vs-plugin-api 0.0.4

Shared plugin models and traits for the vs runtime manager.
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

//! Error types shared by plugin backends and hosts.

use std::path::PathBuf;

use thiserror::Error;

/// Errors shared by plugin backends.
#[derive(Debug, Error)]
pub enum PluginError {
    /// The plugin source could not be parsed.
    #[error("failed to parse plugin source at {path}: {message}")]
    InvalidSource { path: PathBuf, message: String },
    /// The requested plugin version is not exposed by the plugin.
    #[error("plugin {plugin} does not expose version {version}")]
    VersionNotFound { plugin: String, version: String },
    /// The plugin did not provide a result for the requested hook.
    #[error("plugin did not provide a result")]
    NoResultProvided,
    /// The backend hit an execution error.
    #[error("plugin backend error: {0}")]
    Backend(String),
}

/// Shared result type for plugin operations.
pub type PluginResult<T> = Result<T, PluginError>;

/// Extension trait to convert any `Display` error into [`PluginError::Backend`].
pub trait IntoPluginResult<T> {
    fn into_plugin_result(self) -> Result<T, PluginError>;
}

impl<T, E: std::fmt::Display> IntoPluginResult<T> for Result<T, E> {
    fn into_plugin_result(self) -> Result<T, PluginError> {
        self.map_err(|error| PluginError::Backend(error.to_string()))
    }
}