protify 0.1.4

A Rust-first protobuf framework to generate packages from rust code, with validation included
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

use crate::*;

/// A trait that enables the generation of a protobuf service schema.
///
/// Implemented by the enums annotated with the [`proto_service`] macro.
pub trait ProtoService {
	fn proto_schema() -> Service;
}

/// A struct representing a protobuf service.
#[derive(Debug, PartialEq, Builder)]
#[cfg_attr(feature = "std", derive(Template))]
#[cfg_attr(feature = "std", template(path = "service.proto.j2"))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct Service {
	pub name: FixedStr,
	pub file: FixedStr,
	pub options: Vec<ProtoOption>,
	pub handlers: Vec<ServiceHandler>,
	pub package: FixedStr,
}

impl Service {
	/// Renders the schema representation.
	#[cfg(feature = "std")]
	pub fn render_schema(&self) -> Result<String, askama::Error> {
		self.render()
	}
}

/// A struct that represents a protobuf service handler.
#[derive(Debug, PartialEq, Builder)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct ServiceHandler {
	pub name: FixedStr,
	pub options: Vec<ProtoOption>,
	pub request: HandlerTarget,
	pub response: HandlerTarget,
}

/// A struct that represents the target of a service handler, either request or response.
#[derive(Debug, PartialEq, Builder)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct HandlerTarget {
	pub message: ProtoPath,
	pub is_stream: bool,
}