Skip to content

Commit

Permalink
Clarify allocation limit enforcement
Browse files Browse the repository at this point in the history
Co-authored-by: Nick Fitzgerald <[email protected]>
  • Loading branch information
Eliasin and fitzgen committed Jun 9, 2022
1 parent 2438e3b commit 4e3a178
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,9 @@ impl<E: Display> Display for AllocOrInitError<E> {
/// `bumpalo` supports setting a limit on the maximum bytes of memory that can
/// be allocated for use in a particular `Bump` arena. This limit can be set and removed with
/// [`set_allocation_limit`][Bump::set_allocation_limit].
/// Changing the limit for a `Bump` while it has live allocations does
/// nothing until a new allocation is attempted, at which point it may fail
/// due to the new limit.
/// The allocation limit is only enforced when allocating new backing chunks for
/// a `Bump`. Updating the allocation limit will not affect existing allocations
/// or any future allocations within the `Bump`'s current chunk.
///
/// ## Example
///
Expand Down Expand Up @@ -557,9 +557,9 @@ impl Bump {

/// Set the allocation limit in bytes for this arena.
///
/// Changing the limit for a `Bump` while it has live allocations does
/// nothing until a new allocation is attempted, at which point it may fail
/// due to the new limit.
/// The allocation limit is only enforced when allocating new backing chunks for
/// a `Bump`. Updating the allocation limit will not affect existing allocations
/// or any future allocations within the `Bump`'s current chunk.
///
/// ## Example
///
Expand Down

0 comments on commit 4e3a178

Please sign in to comment.