bump-scope 2.2.0

A fast bump allocator that supports allocation scopes / checkpoints. Aka an arena for values of arbitrary types.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

[package]
name = "bump-scope"
version = "2.2.0"
edition = "2024"
license = "MIT OR Apache-2.0"
description = "A fast bump allocator that supports allocation scopes / checkpoints. Aka an arena for values of arbitrary types."
categories = ["memory-management", "no-std", "no-std::no-alloc"]
keywords = ["allocator", "arena", "no-std", "bump", "allocation"]
documentation = "https://docs.rs/bump-scope"
repository = "https://github.com/bluurryy/bump-scope"
rust-version = "1.85.1"
readme = "README.md"
include = ["src/**/*", "/LICENSE-*", "/README.md", "/CHANGELOG.md", "/UPGRADING.md", "!**/tests/**/*"]

[dependencies]
allocator-api2-02 = { package = "allocator-api2", version = "0.2.21", default-features = false, optional = true }
allocator-api2-03 = { package = "allocator-api2", version = "0.3.0", default-features = false, optional = true }
allocator-api2-04 = { package = "allocator-api2", version = "0.4.0", default-features = false, optional = true }
bytemuck = { version = "1.23.0", default-features = false, optional = true }
zerocopy-08 = { package = "zerocopy", version = "0.8.14", default-features = false, optional = true }
serde = { package = "serde_core", version = "1.0.228", default-features = false, optional = true }

[features]
default = ["std", "alloc", "panic-on-alloc"]

## Adds `BumpPool` and implementations of `std::io` traits.
std = ["alloc", "allocator-api2-02?/std", "allocator-api2-03?/std", "allocator-api2-04?/std"]

## Adds `Global` as the default base allocator and some interactions with `alloc` collections.
alloc = ["allocator-api2-02?/alloc", "allocator-api2-03?/alloc", "allocator-api2-04?/alloc"]

## Adds functions and traits that will panic when allocations fail. 
## Without this feature, allocation failures cannot cause panics, and only 
## `try_`-prefixed allocation methods will be available.
panic-on-alloc = []

## Adds `Serialize` implementations for `BumpBox`, strings and vectors, and `DeserializeSeed` for strings and vectors. 
serde = ["dep:serde"]

## Adds `bytemuck::*` extension traits for 
## <code>[alloc_zeroed](bytemuck::BumpAllocatorTypedScopeExt::alloc_zeroed)([_slice](bytemuck::BumpAllocatorTypedScopeExt::alloc_zeroed_slice))</code>, 
## [`init_zeroed`](bytemuck::InitZeroed::init_zeroed),
## [`extend_zeroed`](bytemuck::VecExt::extend_zeroed) and 
## [`resize_zeroed`](bytemuck::VecExt::resize_zeroed).
bytemuck = ["dep:bytemuck"]

## Adds `zerocopy_08::*` extension traits for
## <code>[alloc_zeroed](zerocopy_08::BumpAllocatorTypedScopeExt::alloc_zeroed)([_slice](zerocopy_08::BumpAllocatorTypedScopeExt::alloc_zeroed_slice))</code>, 
## [`init_zeroed`](zerocopy_08::InitZeroed::init_zeroed),
## [`extend_zeroed`](zerocopy_08::VecExt::extend_zeroed) and 
## [`resize_zeroed`](zerocopy_08::VecExt::resize_zeroed).
zerocopy-08 = ["dep:zerocopy-08"]

## Makes `Bump(Scope)` implement `allocator_api2` version `0.2`'s `Allocator` and
## makes it possible to use an `allocator_api2::alloc::Allocator` as a base allocator via
## [`AllocatorApi2V02Compat`](crate::alloc::compat::AllocatorApi2V02Compat).
allocator-api2-02 = ["dep:allocator-api2-02"]

## Makes `Bump(Scope)` implement `allocator_api2` version `0.3`'s `Allocator` and
## makes it possible to use an `allocator_api2::alloc::Allocator` as a base allocator via
## [`AllocatorApi2V03Compat`](crate::alloc::compat::AllocatorApi2V03Compat).
allocator-api2-03 = ["dep:allocator-api2-03"]

## Makes `Bump(Scope)` implement `allocator_api2` version `0.4`'s `Allocator` and
## makes it possible to use an `allocator_api2::alloc::Allocator` as a base allocator via
## [`AllocatorApi2V04Compat`](crate::alloc::compat::AllocatorApi2V04Compat).
allocator-api2-04 = ["dep:allocator-api2-04"]

#! ### Nightly features
#! These nightly features are not subject to the same semver guarantees as the rest of the library. 
#! Breaking changes to these features might be introduced in minor releases to keep up with changes in the nightly channel.

## Enables all other nightly feature flags.
nightly = [
    "nightly-allocator-api",
    "nightly-coerce-unsized",
    "nightly-exact-size-is-empty",
    "nightly-trusted-len",
    "nightly-fn-traits",
    "nightly-tests",
    "nightly-dropck-eyepatch",
    "nightly-clone-to-uninit",
]

## Makes `Bump(Scope)` implement `alloc`'s `Allocator` and
## allows using an `core::alloc::Allocator` as a base allocator via
## [`AllocatorNightlyCompat`](crate::alloc::compat::AllocatorNightlyCompat).
##
## This will also enable `allocator-api2` version `0.2`'s `nightly` feature.
nightly-allocator-api = ["allocator-api2-02/nightly"]

## Makes `BumpBox<T>` implement [`CoerceUnsized`](core::ops::CoerceUnsized).
## With this `BumpBox<[i32;3]>` coerces to `BumpBox<[i32]>`, `BumpBox<dyn Debug>` and so on.
## You can unsize a `BumpBox` in stable without this feature using [`unsize_bump_box`].
nightly-coerce-unsized = []

## Implements `is_empty` manually for some iterators.
nightly-exact-size-is-empty = []

## Implements `TrustedLen` for some iterators.
nightly-trusted-len = []

## Implements `Fn*` traits for `BumpBox<T>`. Makes `BumpBox<T: FnOnce + ?Sized>` callable. Requires alloc crate.
nightly-fn-traits = []

## Enables some tests that require a nightly compiler.
nightly-tests = []

## Adds `#[may_dangle]` attribute to box and vector types' drop implementation.
## This makes it so references don't have to strictly outlive the container.
## (Just like with std's `Box` and `Vec`.)
nightly-dropck-eyepatch = []

## Adds [`alloc_clone`](crate::traits::BumpAllocatorTypedScope::alloc_clone) method.
nightly-clone-to-uninit = []

[dev-dependencies]
trybuild = "1.0.114"
expect-test = "1.5.1"
rayon = "1.11.0"
serde_json = "1.0.145"

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--generate-link-to-definition"]

[package.metadata.release]
allow-branch = ["main"]
pre-release-hook = ["just", "pre-release"]
pre-release-commit-message = "release: version {{version}}"
pre-release-replacements = [
    { file = "CHANGELOG.md", search = "## \\[Unreleased\\]", replace = "## [{{version}}] - {{date}}", exactly = 1 },
    { file = "CHANGELOG.md", search = "\\[Unreleased\\]: .*", replace = "[{{version}}]: https://github.com/bluurryy/bump-scope/releases/tag/v{{version}}" },
    { file = "CHANGELOG.md", search = "#Unreleased", replace = "#{{version}}", min = 0 },
    { file = "CHANGELOG.md", search = "<!-- next-url -->", replace = "<!-- next-url -->\n[Unreleased]: https://github.com/bluurryy/bump-scope/compare/{{tag_name}}...HEAD", exactly = 1 },
    { file = "UPGRADING.md", search = "## \\[Unreleased\\]", replace = "## [{{version}}] - {{date}}", min = 0 },
    { file = "UPGRADING.md", search = "\\[Unreleased\\]: .*", replace = "[{{version}}]: CHANGELOG.md#{{version}}", min = 0 },
    { file = "UPGRADING.md", search = "#Unreleased", replace = "#{{version}}", min = 0 },
]