Skip to content

docs(allocator): document all cargo features #13104

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

Merged
merged 1 commit into from
Aug 14, 2025
Merged

docs(allocator): document all cargo features #13104

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
16 changes: 12 additions & 4 deletions crates/oxc_allocator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,15 @@ This approach is significantly faster than using the system allocator for AST op

## Features

- `serialize` - Enables serialization support for `Box` and `Vec` with `serde`
- `from_raw_parts` - Adds unsafe `from_raw_parts` method (not recommended for general use)
- `track_allocations` - For internal use only. The APIs provided by this feature are sketchy at best,
and possibly undefined behavior. Do not enable this feature under any circumstances in production code.
- `serialize` - Enables serialization support for `Box` and `Vec` with `serde` and `oxc_estree`.
- `from_raw_parts` - Adds unsafe `from_raw_parts` method (not recommended for general use).
- `fixed_size` - Makes `AllocatorPool` create large fixed-size allocators, instead of flexibly-sized ones.
Only supported on 64-bit little-endian platforms at present.
Usage of this feature is not advisable, and it will be removed as soon as we're able to.
- `track_allocations` - Count allocations and reallocations.
For internal use only. The APIs provided by this feature are sketchy at best, and possibly
undefined behavior. Do not enable this feature under any circumstances in production code.
- `disable_fixed_size` - Disables `fixed_size` feature.
Purpose is to prevent `--all-features` enabling fixed sized allocators.
- `disable_track_allocations` - Disables `track_allocations` feature.
Purpose is to prevent `--all-features` enabling allocation tracking.
7 changes: 7 additions & 0 deletions crates/oxc_allocator/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,15 @@
//! Only supported on 64-bit little-endian platforms at present.
//! Usage of this feature is not advisable, and it will be removed as soon as we're able to.
//!
//! * `track_allocations` - Count allocations and reallocations.
//! For internal use only. The APIs provided by this feature are sketchy at best, and possibly
//! undefined behavior. Do not enable this feature under any circumstances in production code.
//!
//! * `disable_fixed_size` - Disables `fixed_size` feature.
//! Purpose is to prevent `--all-features` enabling fixed sized allocators.
//!
//! * `disable_track_allocations` - Disables `track_allocations` feature.
//! Purpose is to prevent `--all-features` enabling allocation tracking.

#![warn(missing_docs)]

Expand Down
Loading