connect2axum-codegen 0.2.0

Protoc generators for REST, WebSocket, OpenAPI, and AsyncAPI wrappers over ConnectRPC services
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

use std::borrow::Cow;

use uni_error::{Cause, UniKind};

/// Error categories produced by the connect2axum protoc generators.
#[derive(Clone, Copy, Debug)]
pub enum CodegenErrKind {
    /// A known plugin option was present but had an invalid value.
    InvalidPluginOption,
    /// The plugin parameter string contained an unsupported option name.
    UnknownPluginOption,
    /// The wrapped grpc-gateway OpenAPI generator failed.
    OpenApiPluginFailed,
    /// The OpenAPI document was not valid JSON or failed structural validation.
    OpenApiInvalidDocument,
    /// Multiple OpenAPI documents could not be merged safely.
    OpenApiMergeConflict,
    /// The generated AsyncAPI document failed structural validation.
    AsyncApiInvalidDocument,
    /// A requested `file_to_generate` was missing from the descriptor set.
    FileToGenerateNotFound,
    /// A protobuf descriptor was malformed or incomplete.
    InvalidDescriptor,
    /// A `google.api.http` annotation could not be decoded.
    InvalidHttpAnnotation,
    /// A `google.api.http` rule used an unsupported binding shape.
    UnsupportedHttpRule,
    /// A field referenced by a path template was missing from the request message.
    PathFieldNotFound,
    /// A method request message could not be resolved.
    RequestMessageNotFound,
    /// A field referenced by an HTTP body option was missing from the request message.
    BodyFieldNotFound,
    /// A protobuf type could not be mapped to the generated Rust type path.
    TypeResolutionFailed,
    /// Generated Rust identifiers would collide.
    DuplicateGeneratedIdentifier,
    /// Two generated handlers would register the same HTTP route.
    DuplicateRoute,
    /// Short API document component names would collide.
    ApiNameCollision,
}

impl UniKind for CodegenErrKind {
    fn context(&self, _cause: Option<Cause<'_>>) -> Option<Cow<'static, str>> {
        match self {
            Self::InvalidPluginOption => Some("invalid connect2axum plugin option".into()),
            Self::UnknownPluginOption => Some("unknown connect2axum plugin option".into()),
            Self::OpenApiPluginFailed => Some("OpenAPI generator failed".into()),
            Self::OpenApiInvalidDocument => Some("invalid OpenAPI document".into()),
            Self::OpenApiMergeConflict => Some("OpenAPI documents could not be merged".into()),
            Self::AsyncApiInvalidDocument => Some("invalid AsyncAPI document".into()),
            Self::FileToGenerateNotFound => {
                Some("file_to_generate was not found in the descriptor set".into())
            }
            Self::InvalidDescriptor => Some("invalid protobuf descriptor".into()),
            Self::InvalidHttpAnnotation => Some("invalid google.api.http annotation".into()),
            Self::UnsupportedHttpRule => Some("unsupported google.api.http rule".into()),
            Self::PathFieldNotFound => Some("google.api.http path field was not found".into()),
            Self::RequestMessageNotFound => Some("request message was not found".into()),
            Self::BodyFieldNotFound => Some("google.api.http body field was not found".into()),
            Self::TypeResolutionFailed => Some("protobuf type could not be resolved".into()),
            Self::DuplicateGeneratedIdentifier => {
                Some("duplicate generated Rust identifier".into())
            }
            Self::DuplicateRoute => Some("duplicate generated route".into()),
            Self::ApiNameCollision => Some("API document component name collision".into()),
        }
    }
}

/// Result type used by connect2axum code generation entry points.
pub type CodegenResult<T> = uni_error::UniResult<T, CodegenErrKind>;