oct 0.37.1

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

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

//! Tests for [`Zeroable`].

#![cfg(test)]

use core::hint::black_box;
use oct::{Zeroable, zeroed};

#[cfg(feature = "alloc")]
use oct::zeroed_boxed_with_metadata;

#[cfg(feature = "proc_macro")]
use core::num::NonZero;

#[cfg(feature = "proc_macro")]
#[test]
fn test_derive_zeroable() {
	#[derive(Zeroable)]
	struct _Type0;

	#[expect(clippy::empty_structs_with_brackets)]
	#[derive(Zeroable)]
	struct _Type1 {}

	#[derive(Zeroable)]
	struct _Type2(i32);

	#[derive(Zeroable)]
	struct _Type3 {
		_field0: i32,
	}

	#[repr(C)]
	#[derive(Zeroable)]
	enum _Type4 {
		_Variant0,
	}

	#[repr(i64)]
	#[derive(Zeroable)]
	enum _Type5 {
		_Variant0 = -1,
		_Variant1,
	}

	#[repr(i8)]
	#[derive(Zeroable)]
	enum _Type6 {
		_Variant0 = -2,
		_Variant1(NonZero<u8>),
		_Variant2(u8),
	}

	#[derive(Zeroable)]
	union _Type7 {
		_field0: Option<NonZero<i32>>,
		_field1: i32,
	}
}

#[cfg(feature = "alloc")]
#[test]
fn test_new_zeroed_boxed() {
	let array = zeroed_boxed_with_metadata::<[i128; 4]>(());
	let slice = zeroed_boxed_with_metadata::<[i128]>(4);

	assert_eq!(array.as_slice(), &[0; 4]);
	assert_eq!(&*slice, &[0; 4]);
}

#[cfg(feature = "alloc")]
#[test]
fn test_new_zeroed_boxed_zst() {
	assert_eq!(
		*zeroed_boxed_with_metadata::<()>(()),
		(),
	);

	assert_eq!(
		*zeroed_boxed_with_metadata::<[i32]>(0),
		[],
	);

	assert_eq!(
		&*zeroed_boxed_with_metadata::<str>(0),
		"",
	);

	assert_eq!(
		&*zeroed_boxed_with_metadata::<str>(5),
		"\0\0\0\0\0",
	);
}

#[test]
fn test_zeroed() {
	#[track_caller]
	fn test<T: Zeroable>() {
		black_box(zeroed::<T>());
	}

	// NOTE: Skip types implementing `FromOctets` as
	// its tests already cover all-zeros.

	test::<Option<fn()>>();

	test::<Option<fn(usize)>>();

	test::<Option<fn(usize, usize)>>();

	test::<Option<fn(usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize, usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize, usize, usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize, usize, usize, usize, usize, usize, usize)>>();

	test::<Option<fn(usize, usize, usize, usize, usize, usize, usize, usize, usize, usize, usize, usize)>>();
}