missing/dyn_vec
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

change crate docs

Browse source
This commit is contained in:
missing 2022-08-14 18:42:10 -05:00
parent 7e743be9d8
commit 672ea5b0bc
1 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/lib.rs
View file

@ -2,14 +2,6 @@
//!
//! A dynamic length collection of unsized elements, akin to [`std::vec::Vec`].
//!
//! This crate is currently stable, but lacks some functionality. To enable this functionality, use the `"unstable"` crate feature, which depends on the following nightly features:
//! - `#![feature(coerce_unsized)]`, to add trait bounds for types which can be unsized to another type.
//!
//! and enables the following functionality (note: these links are probably broken):
//! - [`Vec::push_unsize`]
//! - [`Vec::unsize`]
//! - [`Vec::extend_unsize`]
//!
//! # Examples
//!
//! You can create a vector with [`Vec::new`]:
@ -83,6 +75,22 @@
//!
//! To use the `_stable` variations, one can generally add the argument `|v| v as _`.
//!
//! # Stability
//!
//! This crate is currently stable, but lacks some functionality. To enable this functionality, use the `"unstable"` crate feature, which depends on the following nightly features:
//! - [`#![feature(coerce_unsized)]`](https://github.com/rust-lang/rust/issues/27732)
//!
//! and enables the following functionality (note: these links are probably broken):
//! - [`Vec::push_unsize`]
//! - [`Vec::unsize`]
//! - [`Vec::extend_unsize`]
//!
//! In addition, the `"unstable"` feature also enables dependance on the following nightly features:
//! - [`#![feature(set_ptr_value)]`](https://github.com/rust-lang/rust/issues/75091)
//! - [`#![feature(pointer_byte_offsets)]`](https://github.com/rust-lang/rust/issues/96283)
//!
//! in order to conform to [strict provenance](https://github.com/rust-lang/rust/issues/95228).
//!
//! # Data Layout
//!
//! ```text