oct 0.26.0

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

// Copyright 2024-2025 Gabriel Bjørnager Jensen.
//
// This Source Code Form is subject to the terms of
// the Mozilla Public License, v. 2.0. If a copy of
// the MPL was not distributed with this file, you
// can obtain one at:
// <https://mozilla.org/MPL/2.0/>.

//! Tests for [`Serialise`].

#![cfg(test)]

#[cfg(all(feature = "proc_macro", feature = "alloc"))]
use oct::io::Serialise;

#[cfg(feature = "alloc")]
macro_rules! test {
	{$( $Ty:ty { $($lhs:expr => $rhs:pat),+$(,)? }$(,)?)*} => {
		$($({
			let mut buf = alloc::vec::Vec::<u8>::new();

			let lhs = <$Ty as ::oct::io::Serialise>::serialise(&$lhs, &mut buf)
				.map(|_| buf.as_slice());

			#[allow(clippy::redundant_pattern_matching)]
			if !matches!(lhs, $rhs) {
				::core::panic!(
					"deserialisation test failed: `{lhs:?}` does not match `{}`",
					::core::stringify!($rhs),
				);
			}
		})*)*
	};
}

#[cfg(feature = "alloc")]
#[test]
fn test_serialise() {
	test! {
		u8 {
			0x00 => Ok(&[0x00]),
			0xFF => Ok(&[0xFF]),
			0x7F => Ok(&[0x7F]),
		}

		u16 {
			0x0F_7E => Ok(&[0x7E, 0x0F]),
		}

		u32 {
			0x00_2F_87_E7 => Ok(&[0xE7, 0x87, 0x2F, 0x00]),
		}

		u64 {
			0xF3_37_CF_8B_DB_03_2B_39 => Ok(&[0x39, 0x2B, 0x03, 0xDB, 0x8B, 0xCF, 0x37, 0xF3]),
		}

		u128 {
			0x45_A0_15_6A_36_77_17_8A_83_2E_3C_2C_84_10_58_1A => Ok(&[
				0x1A, 0x58, 0x10, 0x84, 0x2C, 0x3C, 0x2E, 0x83,
				0x8A, 0x17, 0x77, 0x36, 0x6A, 0x15, 0xA0, 0x45,
			]),
		}

		usize {
			0x1A4 => Ok(&[0xA4, 0x01]),

			0x10000 => Err(..),
		}

		[char; 0x5] {
			['\u{03B4}', '\u{0190}', '\u{03BB}', '\u{03A4}', '\u{03B1}'] => Ok(&[
				0xB4, 0x03, 0x00, 0x00, 0x90, 0x01, 0x00, 0x00,
				0xBB, 0x03, 0x00, 0x00, 0xA4, 0x03, 0x00, 0x00,
				0xB1, 0x03, 0x00, 0x00,
			]),
		}

		str {
			"A" => Ok(&[0x01, 0x00, 0x41]),
		}

		str {
			"l\u{00F8}gma\u{00F0}ur" => Ok(&[
				0x0A, 0x00, 0x6C, 0xC3, 0xB8, 0x67, 0x6D, 0x61,
				0xC3, 0xB0, 0x75, 0x72,
			])
		}

		Result<u16, char> {
			Ok(0x4545) => Ok(&[0x00, 0x45, 0x45]),

			Err(char::REPLACEMENT_CHARACTER) => Ok(&[0x01, 0xFD, 0xFF, 0x00, 0x00]),
		}

		Option<()> {
			None => Ok(&[0x00]),

			Some(()) => Ok(&[0x01]),
		}
	}
}

#[cfg(all(feature = "proc_macro", feature = "alloc"))]
#[test]
fn test_derive_serialise() {
	#[derive(Serialise)]
	#[repr(transparent)]
	struct Foo(char);

	#[repr(u8)]
	#[derive(Serialise)]
	enum Bar {
		Unit = 0x45,

		Pretty(bool) = 127,

		Teacher { initials: [char; 0x3] },
	}

	test! {
		Foo {
			Foo('\u{FDF2}') => Ok(&[0xF2, 0xFD, 0x00, 0x00]),
		}

		Bar {
			Bar::Unit => Ok(&[0x00]),

			Bar::Pretty(true) => Ok(&[0x01, 0x01]),

			Bar::Teacher { initials: ['T', 'L', '\0'] } => Ok(&[
				0x02, 0x54, 0x00, 0x00, 0x00, 0x4C, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00,
			]),
		}
	}
}