pinapod 0.4.2

Zero-copy pod types with derive macros. Alignment-1 representations for zero-overhead data access.
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

//! Wire-compatibility checks against the two implementations used by the
//! Criterion comparison.

#![cfg(not(miri))]

const FIXED_SIZE: usize = 45;
const COMPACT_HEADER_SIZE: usize = 15;
const COMPACT_CAPACITY: usize = 207;
const MAX_LABEL: &str = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

macro_rules! historical_fixture {
	($module:ident, $package:ident, $attribute:ident) => {
		mod $module {
			use $package as pinapod;

			#[allow(dead_code)]
			#[derive(pinapod::ZeroPod)]
			pub struct Fixed {
				pub authority: [u8; 32],
				pub amount: u64,
				pub revision: u32,
				pub active: bool,
			}

			#[allow(dead_code)]
			#[derive(pinapod::ZeroPod)]
			#[$attribute(compact)]
			pub struct Compact {
				pub sequence: u64,
				pub revision: u32,
				pub label: pinapod::String<64>,
				pub values: pinapod::Vec<u64, 16>,
			}

			pub fn fixed() -> [u8; super::FIXED_SIZE] {
				let mut data = [0u8; super::FIXED_SIZE];
				let record = <Fixed as pinapod::ZeroPodFixed>::from_bytes_mut(&mut data).unwrap();

				record.authority = [0xA5; 32];
				record.amount = 1_000_000u64.into();
				record.revision = 42u32.into();
				record.active = true.into();
				data
			}

			pub fn compact(
				label: &str,
				value_count: usize,
			) -> ([u8; super::COMPACT_CAPACITY], usize) {
				let mut data = [0u8; super::COMPACT_CAPACITY];
				let values: [pinapod::pod::PodU64; 16] =
					core::array::from_fn(|index| (1 + index as u64).into());
				let mut record = CompactMut::new(&mut data).unwrap();

				record.sequence = 42u64.into();
				record.revision = 7u32.into();
				record.set_label(label).unwrap();
				record.set_values(&values[..value_count]).unwrap();
				let encoded_len = record.commit().unwrap();

				(data, encoded_len)
			}
		}
	};
}

mod current {
	use pinapod::PinaPod;

	#[allow(dead_code)]
	#[derive(PinaPod)]
	pub struct Fixed {
		pub authority: [u8; 32],
		pub amount: u64,
		pub revision: u32,
		pub active: bool,
	}

	#[allow(dead_code)]
	#[derive(PinaPod)]
	#[pinapod(compact)]
	pub struct Compact {
		pub sequence: u64,
		pub revision: u32,
		pub label: pinapod::String<64>,
		pub values: pinapod::Vec<u64, 16>,
	}

	pub fn fixed() -> [u8; super::FIXED_SIZE] {
		let mut data = [0u8; super::FIXED_SIZE];
		Fixed::initialize(&mut data, |record| {
			record.authority = [0xA5; 32];
			record.amount = 1_000_000u64.into();
			record.revision = 42u32.into();
			record.active = true.into();

			Ok(())
		})
		.unwrap();
		data
	}

	pub fn compact(label: &str, value_count: usize) -> ([u8; super::COMPACT_CAPACITY], usize) {
		let mut data = [0u8; super::COMPACT_CAPACITY];
		let values: [pinapod::pod::PodU64; 16] =
			core::array::from_fn(|index| (1 + index as u64).into());
		let patch = CompactPatch::new()
			.sequence(42u64)
			.revision(7u32)
			.label(label)
			.replace_values(&values[..value_count]);
		let encoded_len = Compact::initialize(&mut data, &patch).unwrap();

		(data, encoded_len)
	}
}

historical_fixture!(previous, pinapod_previous, pinapod);
historical_fixture!(upstream, zeropod, zeropod);

#[test]
fn fixed_wire_bytes_match_previous_pinapod_and_upstream_zeropod() {
	let current = current::fixed();

	assert_eq!(current, previous::fixed());
	assert_eq!(current, upstream::fixed());
}

#[test]
fn compact_wire_bytes_match_at_representative_tail_sizes() {
	for (label, value_count) in [
		("small", 1),
		("small", 2),
		("small", 4),
		("small", 8),
		("small", 16),
		(MAX_LABEL, 16),
	] {
		let (current, current_len) = current::compact(label, value_count);
		let (previous, previous_len) = previous::compact(label, value_count);
		let (upstream, upstream_len) = upstream::compact(label, value_count);
		let expected_len = COMPACT_HEADER_SIZE + label.len() + value_count * 8;

		assert_eq!(current_len, expected_len);
		assert_eq!(current_len, previous_len);
		assert_eq!(current_len, upstream_len);
		assert_eq!(&current[..current_len], &previous[..previous_len]);
		assert_eq!(&current[..current_len], &upstream[..upstream_len]);
	}
}