forge-plugin-sdk 0.1.5

OpenAPI Forge plugin author SDK (wasm32-wasip2 only)
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
57
58
59
60
61
62
63

//! Plugin-friendly result types.
//!
//! Plugins author results against these and let the SDK's `convert::*`
//! helpers translate to the WIT-generated equivalents at the boundary.

use crate::ir;

/// Mirror of the WIT `file-mode` enum, world-independent so plugins can
/// build `OutputFile`s without touching either world's bindings.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum FileMode {
    Text,
    Binary,
    Executable,
}

/// One file produced by a generator. Mirrors WIT `output-file`.
#[derive(Debug, Clone, PartialEq)]
pub struct OutputFile {
    pub path: String,
    pub content: Vec<u8>,
    pub mode: FileMode,
}

impl OutputFile {
    pub fn text(path: impl Into<String>, content: impl Into<String>) -> Self {
        Self {
            path: path.into(),
            content: content.into().into_bytes(),
            mode: FileMode::Text,
        }
    }

    pub fn binary(path: impl Into<String>, content: impl Into<Vec<u8>>) -> Self {
        Self {
            path: path.into(),
            content: content.into(),
            mode: FileMode::Binary,
        }
    }

    pub fn executable(path: impl Into<String>, content: impl Into<Vec<u8>>) -> Self {
        Self {
            path: path.into(),
            content: content.into(),
            mode: FileMode::Executable,
        }
    }
}

/// What a generator returns. Mirrors WIT `generation-output`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct GenerationOutput {
    pub files: Vec<OutputFile>,
    pub diagnostics: Vec<ir::Diagnostic>,
}

/// What a transformer returns. Mirrors WIT `transform-output`.
#[derive(Debug, Clone, PartialEq)]
pub struct TransformOutput {
    pub spec: ir::Ir,
    pub diagnostics: Vec<ir::Diagnostic>,
}