oas-forge 0.1.4

The zero-runtime OpenAPI 3.1 compiler for Rust. Extracts, links, and merges code-first documentation.
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

use std::path::PathBuf;
use thiserror::Error;

#[derive(Error, Debug)]
pub enum Error {
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    #[error("YAML parsing error: {0}")]
    Yaml(#[from] serde_yaml_ng::Error),

    #[error("JSON parsing error: {0}")]
    Json(#[from] serde_json::Error),

    #[error("TOML parsing error: {0}")]
    Toml(#[from] toml::de::Error),

    #[error("Syntactic parsing error in file {file:?}: {source}")]
    Parse { file: PathBuf, source: syn::Error },

    #[error(
        "Validation failed: No Root OpenAPI definition found. One definition must contain 'openapi' and 'info' fields."
    )]
    NoRootFound,

    #[error(
        "Validation failed: Multiple Root OpenAPI definitions found. Only one definition can be the Root."
    )]
    MultipleRootsFound,

    #[error("Empty input: No files found in the specified directories.")]
    NoFilesFound,

    #[error("YAML error in {file}:{line}: {source}\nContext:\n{context}")]
    SourceMapped {
        file: PathBuf,
        line: usize,
        source: serde_yaml_ng::Error,
        context: String,
    },
}

pub type Result<T> = std::result::Result<T, Error>;