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

use std::collections::HashMap;

use protify::*;

proto_package!(TESTING_PKG, name = "testing", no_cel_test);

define_proto_file!(TESTING, name = "testing.proto", package = TESTING_PKG);

#[allow(clippy::use_self)]
#[proto_message]
#[proto(skip_checks(all))]
struct MsgWithNoValidator {
	id: i32,
	#[proto(oneof(tags(1, 2, 3)))]
	oneof: Option<OneofWithNoValidator>,
	#[proto(message)]
	recursive: Option<Box<MsgWithNoValidator>>,
	#[proto(repeated(message))]
	vec: Vec<MsgWithNoValidator>,
	#[proto(map(int32, message))]
	map: HashMap<i32, MsgWithNoValidator>,
	#[proto(message)]
	second_degree_recursion: Option<SecondDegreeRecursion>,
}

#[proto_message]
#[proto(skip_checks(all))]
struct SecondDegreeRecursion {
	#[proto(message)]
	recursive: Option<Box<MsgWithNoValidator>>,
	#[proto(oneof(tags(1, 2, 3)))]
	third_degree_recursion: Option<OneofWithNoValidator>,
}

#[proto_oneof]
#[proto(skip_checks(all))]
enum OneofWithNoValidator {
	#[proto(tag = 1)]
	A(i32),
	#[proto(tag = 2)]
	B(i32),
	#[proto(tag = 3, message)]
	Recursive(Box<MsgWithNoValidator>),
}

// You can clone the repo and run `just check-asm-output` to view the asm output of this function.
//
// If the validator is being correctly detected as empty, the assembly output should be just an empty return:
//
// .section .text.trigger_validation,"ax",@progbits
// .globl  trigger_validation
// .p2align        4
// .type   trigger_validation,@function
// trigger_validation:
// .cfi_startproc
// ret
#[unsafe(no_mangle)]
#[inline(never)]
fn trigger_validation(msg: &MsgWithNoValidator) {
	let _ = msg.validate();
}

// Dummy fn that should crash the test if there is a regression
// about code elimination
unsafe extern "C" {
	fn __this_code_should_have_been_eliminated();
}

#[test]
fn code_elimination_test() {
	if MsgWithNoValidator::HAS_DEFAULT_VALIDATOR
	  // The check above actually implies these two,
		// but we add them manually out of caution
    || OneofWithNoValidator::HAS_DEFAULT_VALIDATOR
    || SecondDegreeRecursion::HAS_DEFAULT_VALIDATOR
	{
		unsafe { __this_code_should_have_been_eliminated() }
	}
}