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
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

use crate::*;

/// Struct that represents a protobuf field.
#[derive(Debug, Clone, PartialEq, Builder)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct Field {
	pub name: FixedStr,
	pub tag: i32,
	pub type_: FieldType,
	pub options: Vec<ProtoOption>,
	pub validators: Vec<ValidatorSchema>,
}

impl Field {
	/// Collects all the options of the field, including those created by the [`ValidatorSchema`]s.
	pub fn options_with_validators(&self) -> impl Iterator<Item = &options::ProtoOption> {
		self.options
			.iter()
			.chain(self.validators.iter().map(|v| &v.schema))
	}

	pub(crate) fn register_import_path(&self, imports: &mut FileImports) {
		for import in self
			.validators
			.iter()
			.flat_map(|v| v.imports.clone())
		{
			imports.insert_internal(import);
		}

		match &self.type_ {
			FieldType::Normal(ty) | FieldType::Repeated(ty) | FieldType::Optional(ty) => {
				ty.register_import(imports)
			}
			FieldType::Map { keys, values } => {
				keys.into_type().register_import(imports);
				values.register_import(imports);
			}
		};
	}
}

/// A schema representation for a validator.
///
/// It allows the validator to be turned into a protobuf representation
/// that can be generated inside a message's options in the target protobuf file.
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct ValidatorSchema {
	pub schema: ProtoOption,
	/// Adds several rules to this validator schema so that the containing [`Package`] can check if there are multiple rules with the same ID within the same message scope.
	///
	/// This does not affect the schema output and is purely for the duplication check logic.
	pub cel_rules: Vec<CelRule>,
	/// Sets a list of imports that will be added to the file where this [`ValidatorSchema`] is used.
	pub imports: Vec<FixedStr>,
}

impl ValidatorSchema {
	/// Creates a new instance.
	#[inline]
	pub const fn new(schema: ProtoOption) -> Self {
		Self {
			schema,
			cel_rules: vec![],
			imports: vec![],
		}
	}

	/// Adds several rules to this validator schema so that the containing [`Package`] can check if there are multiple rules with the same ID within the same message scope.
	///
	/// This does not affect the schema output and is purely for the duplication check logic.
	#[must_use]
	#[inline]
	pub fn with_cel_rules(mut self, cel_rules: Vec<CelRule>) -> Self {
		self.cel_rules = cel_rules;
		self
	}

	/// Sets a list of imports that will be added to the file where this [`ValidatorSchema`] is used.
	#[must_use]
	#[inline]
	pub fn with_imports(mut self, imports: Vec<FixedStr>) -> Self {
		self.imports = imports;
		self
	}
}