warpgate_api 0.17.5

APIs for working with Warpgate plugins.
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

mod host;
mod host_funcs;
mod locator;
mod locator_error;
mod virtual_path;

pub use anyhow::anyhow;
pub use host::*;
pub use host_funcs::*;
pub use locator::*;
pub use locator_error::*;
pub use starbase_id::*;
pub use virtual_path::*;

/// Wrap a struct with common derives and serde required attributes.
#[macro_export]
macro_rules! api_struct {
    ($struct:item) => {
        #[derive(Clone, Debug, Default, serde::Deserialize, PartialEq, serde::Serialize)]
        #[cfg_attr(feature = "schematic", derive(schematic::Schematic))]
        $struct
    };
}

/// Wrap an enum with common derives and serde required attributes.
#[macro_export]
macro_rules! api_enum {
    ($struct:item) => {
        #[derive(Clone, Debug, serde::Deserialize, PartialEq, serde::Serialize)]
        #[cfg_attr(feature = "schematic", derive(schematic::Schematic))]
        $struct
    };
}

/// Wrap a unit-only enum with common derives and serde required attributes.
#[macro_export]
macro_rules! api_unit_enum {
    ($struct:item) => {
        #[derive(Clone, Copy, Debug, Default, serde::Deserialize, PartialEq, serde::Serialize)]
        #[serde(rename_all = "kebab-case")]
        #[cfg_attr(feature = "schematic", derive(schematic::Schematic))]
        $struct
    };
}

api_struct!(
    /// Represents an empty input.
    pub struct EmptyInput {}
);

/// Represents any result (using `anyhow`).
pub type AnyResult<T> = anyhow::Result<T>;