oct 0.36.2

Octonary transcodings.
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

// Copyright 2024-2026 Gabriel Bjørnager Jensen.
//
// SPDX: MIT OR Apache-2.0

//! Tests for [`MaxSerialisedSize`].

#![allow(clippy::missing_docs_in_private_items)]
#![allow(clippy::missing_errors_doc)]

#![cfg(test)]

use oct::serdes::{MaxSerialisedSize, Serialise};

#[cfg(feature = "proc_macro")]
use core::mem::ManuallyDrop;

#[cfg(feature = "simd")]
use core::simd::{self, Simd};

#[cfg(feature = "proc_macro")]
#[test]
fn test_derive_max_serialised_size() {
	#[derive(MaxSerialisedSize)]
	struct StructUnit;

	#[derive(MaxSerialisedSize)]
	struct StructNamed {
		_raw_name: [u8; 16],

		_birthday: u64,
	}

	#[derive(MaxSerialisedSize)]
	struct StructUnnamed(
		#[expect(unused)]
		[f64; 6],
	);

	#[expect(unused)]
	#[derive(MaxSerialisedSize)]
	enum Enum {
		Unit,

		Named {
			named: StructNamed,
		},

		Unnamed(StructUnnamed),
	}

	#[derive(MaxSerialisedSize)]
	union Union<T: MaxSerialisedSize> {
		_null: ManuallyDrop<[T; 0]>,

		_single: ManuallyDrop<[T; 1]>,

		_double: ManuallyDrop<[T; 2]>,
	}

	assert_eq!(StructUnit::MAX_SERIALISED_SIZE,    0);
	assert_eq!(StructNamed::MAX_SERIALISED_SIZE,   24);
	assert_eq!(StructUnnamed::MAX_SERIALISED_SIZE, 48);
	assert_eq!(Enum::MAX_SERIALISED_SIZE,          49);
	assert_eq!(Union::<u128>::MAX_SERIALISED_SIZE, 32);
}

#[test]
fn test_max_serialised_size() {
	struct Test<const N: usize> {
		buf: [u8; N],
	}

	impl<const N: usize> Test<N> {
		#[must_use]
		pub fn new() -> Self {
			Self { buf: [0; N] }
		}

		#[must_use]
		fn serialised_size<T: Serialise>(&mut self, value: T) -> usize {
			let mut w = self.buf.as_mut_slice();

			value.serialise(&mut w).unwrap();

			let remaining = w.len();
			self.buf.len() - remaining
		}

		#[track_caller]
		fn assert_eq_serialised_size<T: Serialise + MaxSerialisedSize>(&mut self, value: T) {
			assert!(self.serialised_size(value) == T::MAX_SERIALISED_SIZE);
		}

		#[track_caller]
		fn assert_le_serialised_size<T: Serialise + MaxSerialisedSize>(&mut self, value: T) {
			assert!(self.serialised_size(value) <= T::MAX_SERIALISED_SIZE);
		}
	}

	let mut test = Test::<512>::new();

	test.assert_eq_serialised_size([u128::MAX; 32]);
	test.assert_eq_serialised_size([u16::MAX; 256]);
	test.assert_eq_serialised_size([u32::MAX; 128]);
	test.assert_eq_serialised_size([u64::MAX; 64]);
	test.assert_eq_serialised_size([u8::MAX; 0]);
	test.assert_eq_serialised_size([u8::MAX; 512]);
	test.assert_eq_serialised_size(true);
	test.assert_eq_serialised_size(char::MAX);
	test.assert_eq_serialised_size(f32::INFINITY);
	test.assert_eq_serialised_size(f64::INFINITY);
	test.assert_eq_serialised_size(i128::MAX);
	test.assert_eq_serialised_size(i16::MAX);
	test.assert_eq_serialised_size(i32::MAX);
	test.assert_eq_serialised_size(i64::MAX);
	test.assert_eq_serialised_size(i8::MAX);
	test.assert_le_serialised_size(Option::<i128>::None);
	test.assert_eq_serialised_size(Option::<i128>::Some(0));
	test.assert_eq_serialised_size(Option::<()>::None);
	test.assert_eq_serialised_size(Option::<()>::Some(()));
	test.assert_le_serialised_size(Result::<u8, u16>::Ok(0));
	test.assert_eq_serialised_size(Result::<u8, u16>::Err(0));
	test.assert_eq_serialised_size(Result::<(), ()>::Ok(()));
	test.assert_eq_serialised_size(Result::<(), ()>::Err(()));
	test.assert_eq_serialised_size(u128::MAX);
	test.assert_eq_serialised_size(u16::MAX);
	test.assert_eq_serialised_size(u32::MAX);
	test.assert_eq_serialised_size(u64::MAX);
	test.assert_eq_serialised_size(u8::MAX);

	#[cfg(feature = "f16")]
	test.assert_eq_serialised_size(f16::INFINITY);

	#[cfg(feature = "f128")]
	test.assert_eq_serialised_size(f128::INFINITY);

	#[cfg(feature = "simd")]
	test.assert_eq_serialised_size(simd::Mask::<i64, 64>::from_array([true; 64]));

	#[cfg(feature = "simd")]
	test.assert_eq_serialised_size(Simd::from_array([u64::MAX; 64]));
}