Skip to content

Commit

Permalink
doc: don't mention Drain specifically in the feature docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bluurryy committed Jun 20, 2024
1 parent 0eec857 commit 271fe44
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ nightly-coerce-unsized = []
## Makes `Bump::unallocated` a `const fn`.
nightly-const-refs-to-static = []

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

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

[dev-dependencies]
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ assert_eq!(bump.stats().allocated(), 4);
* **`nightly-coerce-unsized`** — Makes `BumpBox<T>` implement [`CoerceUnsized`](core::ops::CoerceUnsized).
With this `BumpBox<[i32;3]>` coerces to `BumpBox<[i32]>`, `BumpBox<dyn Debug>` and so on.
* **`nightly-const-refs-to-static`** — Makes `Bump::unallocated` a `const fn`.
* **`nightly-exact-size-is-empty`** — Implements `is_empty` manually for `Drain`.
* **`nightly-trusted-len`** — Implements `TrustedLen` for `Drain`.
* **`nightly-exact-size-is-empty`** — Implements `is_empty` manually for some iterators.
* **`nightly-trusted-len`** — Implements `TrustedLen` for some iterators.

## Bumping upwards or downwards?
Bump direction is controlled by the generic parameter `const UP: bool`. By default, `UP` is `true`, so the allocator bumps upwards.
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,8 @@
//! * **`nightly-coerce-unsized`** — Makes `BumpBox<T>` implement [`CoerceUnsized`](core::ops::CoerceUnsized).
//! With this `BumpBox<[i32;3]>` coerces to `BumpBox<[i32]>`, `BumpBox<dyn Debug>` and so on.
//! * **`nightly-const-refs-to-static`** — Makes `Bump::unallocated` a `const fn`.
//! * **`nightly-exact-size-is-empty`** — Implements `is_empty` manually for `Drain`.
//! * **`nightly-trusted-len`** — Implements `TrustedLen` for `Drain`.
//! * **`nightly-exact-size-is-empty`** — Implements `is_empty` manually for some iterators.
//! * **`nightly-trusted-len`** — Implements `TrustedLen` for some iterators.
//!
//! # Bumping upwards or downwards?
//! Bump direction is controlled by the generic parameter `const UP: bool`. By default, `UP` is `true`, so the allocator bumps upwards.
Expand Down

0 comments on commit 271fe44

Please sign in to comment.