protoc-gen-prost 0.3.0

Protocol Buffers compiler plugin powered by Prost!
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! Code generator modules

use prost_types::compiler::{
    code_generator_response::{Feature, File},
    CodeGeneratorResponse,
};

use crate::ModuleRequestSet;

mod core;
mod file_descriptor_set;

pub(crate) use self::{core::CoreProstGenerator, file_descriptor_set::FileDescriptorSetGenerator};

/// A code generation result
pub type Result = std::result::Result<Vec<File>, Error>;
/// A code generation error
pub type Error = Box<dyn std::error::Error + Send + Sync + 'static>;

/// Extension function to assist in converting [`Result`] into a [`CodeGeneratorResponse`]
pub trait GeneratorResultExt {
    /// Unwrap a [`Result`], producing the relevant [`CodeGeneratorResponse`]
    fn unwrap_codegen_response(self) -> CodeGeneratorResponse;
}

impl GeneratorResultExt for Result {
    fn unwrap_codegen_response(self) -> CodeGeneratorResponse {
        match self {
            Ok(file) => CodeGeneratorResponse {
                file,
                supported_features: Some(Feature::Proto3Optional as u64),
                ..Default::default()
            },
            Err(error) => error_to_codegen_response(&*error),
        }
    }
}

fn error_to_codegen_response(error: &dyn std::error::Error) -> CodeGeneratorResponse {
    CodeGeneratorResponse {
        error: Some(error.to_string()),
        supported_features: Some(Feature::Proto3Optional as u64),
        ..Default::default()
    }
}

/// A code generator
pub trait Generator {
    /// Generate one or more files based on the input request
    fn generate(&mut self, module_request_set: &ModuleRequestSet) -> Result;

    /// Chain multiple generators together, returning their composite output
    fn chain<G>(self, next: G) -> ChainedGenerator<Self, G>
    where
        Self: Sized,
    {
        ChainedGenerator {
            generator1: self,
            generator2: next,
        }
    }
}

/// A chain of generators, executed sequentially
///
/// Executes `G1` followed by `G2`, returning generated files in the same order as
/// produced. Execution short circuits in the event `G1` returns an error.
pub struct ChainedGenerator<G1, G2> {
    generator1: G1,
    generator2: G2,
}

impl<G1, G2> Generator for ChainedGenerator<G1, G2>
where
    G1: Generator,
    G2: Generator,
{
    fn generate(&mut self, module_request_set: &ModuleRequestSet) -> Result {
        let mut files = self.generator1.generate(module_request_set)?;
        files.extend(self.generator2.generate(module_request_set)?);
        Ok(files)
    }
}

impl<G> Generator for Option<G>
where
    G: Generator,
{
    fn generate(&mut self, module_request_set: &ModuleRequestSet) -> Result {
        if let Some(slf) = self {
            slf.generate(module_request_set)
        } else {
            Ok(Vec::new())
        }
    }
}