[#476] Introduce test feature in iceoryx-bb for bump_allocator

eclipse-iceoryx · Oct 18, 2024 · e3225b5 · e3225b5
1 parent 4dc37ec
commit e3225b5
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/iceoryx2-bb/container/Cargo.toml b/iceoryx2-bb/container/Cargo.toml
@@ -23,3 +23,4 @@ serde = { workspace = true }
 generic-tests = { workspace = true }
 iceoryx2-bb-testing = { workspace = true }
 serde_test = { workspace = true }
+iceoryx2-bb-elementary = { workspace = true, features = ["testing"]}
diff --git a/iceoryx2-bb/elementary/Cargo.toml b/iceoryx2-bb/elementary/Cargo.toml
@@ -18,3 +18,5 @@ iceoryx2-bb-testing = { workspace = true }
 
 generic-tests = { workspace = true }
 
+[features]
+testing = []
diff --git a/iceoryx2-bb/elementary/src/bump_allocator.rs b/iceoryx2-bb/elementary/src/bump_allocator.rs
@@ -16,7 +16,6 @@ use std::sync::atomic::Ordering;
 
 /// Simple BumpAllocator for testing purposes. Do not use this in production. If you are looking
 /// for a production ready BumpAllocator use the one from iceoryx2_bb_memory::bump_allocator
-#[doc(hidden)]
 pub struct BumpAllocator {
     start: usize,
     pos: IoxAtomicUsize,

diff --git a/iceoryx2-bb/elementary/src/lib.rs b/iceoryx2-bb/elementary/src/lib.rs
@@ -18,6 +18,8 @@ pub mod enum_gen;
 /// A strong type that represents the alignment part of [`std::alloc::Layout`]
 pub mod alignment;
 pub mod allocator;
+
+#[cfg(feature = "testing")]
 pub mod bump_allocator;
 pub mod lazy_singleton;
 pub mod math;