Skip to content

Commit

Permalink
add alloc feature change to readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
y86-dev committed Jul 7, 2024
1 parent 43be98d commit 3a67aa0
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
parameter `E`)
- removed the default error of `try_[pin_]init!`, now you always have to specify an error using
`? Error` at the end
- put `InPlaceInit` behind the `alloc` feature flag, this allows stable usage of the `#![no_std]`
part of the crate

## [0.0.7] - 2024-04-09

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ it into it's final memory location.

This library allows you to do in-place initialization safely.

## Nightly only
### Nightly Needed for `alloc` and `std` features

This library requires unstable features and thus can only be used with a nightly compiler.
The internally used features are:
This library requires unstable features when the `alloc` or `std` features are enabled and thus
can only be used with a nightly compiler. The internally used features are:
- `allocator_api`
- `new_uninit` (only if the `alloc` or `std` features are enabled)
- `get_mut_unchecked` (only if the `alloc` or `std` features are enabled)
- `new_uninit`
- `get_mut_unchecked`

The user will be required to activate these features:
When enabling the `alloc` or `std` feature, the user will be required to activate these features:
- `allocator_api`

## Overview
Expand Down
12 changes: 6 additions & 6 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@
//!
//! This library allows you to do in-place initialization safely.
//!
//! # Nightly only
//! ## Nightly Needed for `alloc` and `std` features
//!
//! This library requires unstable features and thus can only be used with a nightly compiler.
//! The internally used features are:
//! This library requires unstable features when the `alloc` or `std` features are enabled and thus
//! can only be used with a nightly compiler. The internally used features are:
//! - `allocator_api`
//! - `new_uninit` (only if the `alloc` or `std` features are enabled)
//! - `get_mut_unchecked` (only if the `alloc` or `std` features are enabled)
//! - `new_uninit`
//! - `get_mut_unchecked`
//!
//! The user will be required to activate these features:
//! When enabling the `alloc` or `std` feature, the user will be required to activate these features:
//! - `allocator_api`
//!
//! # Overview
Expand Down

0 comments on commit 3a67aa0

Please sign in to comment.