Skip to content

Allow setting visibility of the pool struct in the box_pool! macro #597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Allow setting visibility of the pool struct in the box_pool! macro #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]

- Make MSRV of 1.87.0 explicit.
- Allow setting visibility for the pool struct in the `box_pool!` macro.

## [v0.9.1] - 2025-08-19

Expand Down
7 changes: 4 additions & 3 deletions src/pool/boxed.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@
//! use core::ptr::addr_of_mut;
//! use heapless::{box_pool, pool::boxed::BoxBlock};
//!
//! box_pool!(MyBoxPool: u128);
//! // You can optionally set visibility for the pool struct.
//! box_pool!(pub MyBoxPool: u128);
//!
//! const POOL_CAPACITY: usize = 8;
//!
Expand Down Expand Up @@ -96,8 +97,8 @@ use super::treiber::{NonNullPtr, Stack, UnionNode};
/// For more extensive documentation see the [module level documentation](crate::pool::boxed)
#[macro_export]
macro_rules! box_pool {
($name:ident: $data_type:ty) => {
pub struct $name;
($visibility:vis $name:ident: $data_type:ty) => {
$visibility struct $name;

impl $crate::pool::boxed::BoxPool for $name {
type Data = $data_type;
Expand Down