dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-19 04:08:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(allocator): clarify docs for Box (#6625)

Browse source 
Clarify the consequences of storing `Drop` types in `oxc_allocator::Box`.
This commit is contained in:
overlookmotel 2024-10-16 15:35:53 +00:00
parent 2673397122
commit 9f555d7c7f
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
crates/oxc_allocator/src/boxed.rs
View file

@ -16,10 +16,16 @@ use serde::{Serialize, Serializer};
use crate::Allocator;
/// A Box without [`Drop`].
/// A `Box` without [`Drop`], which stores its data in the arena allocator.
///
/// This is used for over coming self-referential structs.
/// It is a memory leak if the boxed value has a [`Drop`] implementation.
/// Should only be used for storing AST types.
///
/// Must NOT be used to store types which have a [`Drop`] implementation.
/// `T::drop` will NOT be called on the `Box`'s contents when the `Box` is dropped.
/// If `T` owns memory outside of the arena, this will be a memory leak.
///
/// Note: This is not a soundness issue, as Rust does not support relying on `drop`
/// being called to guarantee soundness.
pub struct Box<'alloc, T: ?Sized>(NonNull<T>, PhantomData<(&'alloc (), T)>);
impl<'alloc, T> Box<'alloc, T> {