itsscb/heapless
1
0
Fork 0
mirror of https://github.com/rust-embedded/heapless.git synced 2025-10-02 14:54:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #581 from zeenix/fix-docs

Browse Source 
Minor fixes to `pool` docs
This commit is contained in:
Zeeshan Ali Khan 2025-08-11 12:45:10 +00:00 committed by GitHub
commit 779e608eb6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- `bytes::BufMut` is now implemented on `VecInner`. - `bytes::BufMut` is now implemented on `VecInner`.
- Removed generic from `history_buf::OldestOrdered`. - Removed generic from `history_buf::OldestOrdered`.
- Made `LenType` opt-in. - Made `LenType` opt-in.
- Minor fixes to `pool::boxed` docs.
### Fixed ### Fixed

2
src/pool.rs
View File

@ -6,7 +6,7 @@
//! //!
//! - ARM architectures which instruction set include the LDREX, CLREX and STREX instructions, e.g. //! - ARM architectures which instruction set include the LDREX, CLREX and STREX instructions, e.g.
//! `thumbv7m-none-eabi` but not `thumbv6m-none-eabi` //! `thumbv7m-none-eabi` but not `thumbv6m-none-eabi`
//! - 32-bit x86, e.g. `i686-unknown-linux-gnu` //! - 32-bit and 64-bit x86.
//! //!
//! # Benchmarks //! # Benchmarks
//! //!

3
src/pool/boxed.rs
View File

@ -3,6 +3,7 @@
//! # Example usage //! # Example usage
//! //!
//! ``` //! ```
//! use core::ptr::addr_of_mut;
//! use heapless::{box_pool, pool::boxed::{Box, BoxBlock}}; //! use heapless::{box_pool, pool::boxed::{Box, BoxBlock}};
//! //!
//! box_pool!(MyBoxPool: u128); //! box_pool!(MyBoxPool: u128);
@ -70,7 +71,7 @@
//! #[allow(clippy::declare_interior_mutable_const)] //! #[allow(clippy::declare_interior_mutable_const)]
//! const BLOCK: BoxBlock<u128> = BoxBlock::new(); // <= //! const BLOCK: BoxBlock<u128> = BoxBlock::new(); // <=
//! static mut BLOCKS: [BoxBlock<u128>; POOL_CAPACITY] = [BLOCK; POOL_CAPACITY]; //! static mut BLOCKS: [BoxBlock<u128>; POOL_CAPACITY] = [BLOCK; POOL_CAPACITY];
//! unsafe { addr_of_mut!(BLOCK).as_mut().unwrap()S } //! unsafe { addr_of_mut!(BLOCKS).as_mut().unwrap() }
//! }; //! };
//! //!
//! for block in blocks { //! for block in blocks {