openapi-nexus 0.2.3

OpenAPI 3.x multi-language code generator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

//! Trait for language-specific code generators

use std::error::Error;

use super::file_writer::FileInfo;
use crate::ir::types::IrSpec;
use crate::{GeneratorType, Language};

/// Trait for code generators.
///
/// Generators receive a version-agnostic [`IrSpec`] (lowered by the
/// orchestrator) and return a list of files. How a generator decomposes
/// its pipeline internally is up to the implementation.
pub trait CodeGenerator {
    /// Returns the target language.
    fn language(&self) -> Language;

    /// Returns the generator type identifier.
    fn generator_type(&self) -> GeneratorType;

    /// Generate files from a lowered IR specification.
    fn generate(&self, ir: &IrSpec) -> Result<Vec<FileInfo>, Box<dyn Error + Send + Sync>>;
}