iceoryx2-bb-elementary 0.8.1

iceoryx2: [internal] elementary constructs that have (almost) no dependencies at all
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

// Copyright (c) 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Static assertions in Rust.
//!
//! Useful for compile time assertions.
//!
//! # Example
//!
//! ```
//! use iceoryx2_bb_elementary::static_assert::*;
//!
//! use core::mem::{align_of, size_of};
//!
//! static_assert_eq::<{ size_of::<u64>() }, 8>();
//! static_assert_ge::<{ size_of::<u64>() }, { size_of::<u32>() }>();
//! static_assert_gt::<{ size_of::<u64>() }, { size_of::<u32>() }>();
//! static_assert_le::<{ size_of::<u32>() }, { size_of::<u64>() }>();
//! static_assert_lt::<{ size_of::<u32>() }, { size_of::<u64>() }>();
//! ```

/// A compile time assert to check for equal values
///
/// # Examples
///
/// This does compile!
///
/// ```
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_eq::<1, 1>();
///
/// ```
///
/// This does not compile!
///
/// ```compile_fail
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_eq::<1, 2>();
/// static_assert_eq::<2, 1>();
///
/// ```
pub const fn static_assert_eq<const L: usize, const R: usize>() {
    let () = AssertEq::<L, R>::OK;
}

struct AssertEq<const L: usize, const R: usize>;

impl<const L: usize, const R: usize> AssertEq<L, R> {
    const OK: () = assert!(L == R, "L must be equal to R");
}

/// A compile time assert to check for greater than or equal values
///
/// # Examples
///
/// This does compile!
///
/// ```
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_ge::<1, 1>();
/// static_assert_ge::<2, 1>();
///
/// ```
///
/// This does not compile!
///
/// ```compile_fail
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_ge::<1, 2>();
///
/// ```
pub const fn static_assert_ge<const L: usize, const R: usize>() {
    let () = AssertGe::<L, R>::OK;
}

struct AssertGe<const L: usize, const R: usize>;

impl<const L: usize, const R: usize> AssertGe<L, R> {
    const OK: () = assert!(L >= R, "L must be greater than or equal to R");
}

/// A compile time assert to check for greater than values
///
/// # Examples
///
/// This does compile!
///
/// ```
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_gt::<2, 1>();
///
/// ```
///
/// This does not compile!
///
/// ```compile_fail
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_gt::<1, 1>();
/// static_assert_gt::<1, 2>();
///
/// ```
pub const fn static_assert_gt<const L: usize, const R: usize>() {
    let () = AssertGt::<L, R>::OK;
}

struct AssertGt<const L: usize, const R: usize>;

impl<const L: usize, const R: usize> AssertGt<L, R> {
    const OK: () = assert!(L > R, "L must be greater than R");
}

/// A compile time assert to check for less than or equal values
///
/// # Examples
///
/// This does compile!
///
/// ```
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_le::<1, 1>();
/// static_assert_le::<1, 2>();
///
/// ```
///
/// This does not compile!
///
/// ```compile_fail
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_le::<2, 1>();
///
/// ```
pub const fn static_assert_le<const L: usize, const R: usize>() {
    let () = AssertLe::<L, R>::OK;
}

struct AssertLe<const L: usize, const R: usize>;

impl<const L: usize, const R: usize> AssertLe<L, R> {
    const OK: () = assert!(L <= R, "L must be less than or equal to R");
}

/// A compile time assert to check for less than values
///
/// # Examples
///
/// This does compile!
///
/// ```
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_lt::<1, 2>();
///
/// ```
///
/// This does not compile!
///
/// ```compile_fail
/// use iceoryx2_bb_elementary::static_assert::*;
///
/// static_assert_lt::<1, 1>();
/// static_assert_lt::<2, 1>();
///
/// ```
pub const fn static_assert_lt<const L: usize, const R: usize>() {
    let () = AssertLt::<L, R>::OK;
}

struct AssertLt<const L: usize, const R: usize>;

impl<const L: usize, const R: usize> AssertLt<L, R> {
    const OK: () = assert!(L < R, "L must be less than R");
}