mirror of
https://github.com/openharmony/third_party_rust_rust-smallvec.git
synced 2026-07-21 01:55:25 -04:00
Document no_std support
This commit is contained in:
+1
-1
@@ -5,7 +5,7 @@ authors = ["Simon Sapin <simon.sapin@exyr.org>"]
|
||||
license = "MPL-2.0"
|
||||
repository = "https://github.com/servo/rust-smallvec"
|
||||
description = "'Small vector' optimization: store up to a small number of items on the stack"
|
||||
keywords = ["small", "vec", "vector", "stack"]
|
||||
keywords = ["small", "vec", "vector", "stack", "no_std"]
|
||||
readme = "README.md"
|
||||
documentation = "http://doc.servo.org/smallvec/"
|
||||
|
||||
|
||||
@@ -5,6 +5,15 @@
|
||||
//! Small vectors in various sizes. These store a certain number of elements inline, and fall back
|
||||
//! to the heap for larger allocations. This can be a useful optimization for improving cache
|
||||
//! locality and reducing allocator traffic for workloads that fit within the inline buffer.
|
||||
//!
|
||||
//! ## no_std support
|
||||
//!
|
||||
//! By default, `smallvec` depends on `libstd`. However, it can be configured to use the unstable
|
||||
//! `liballoc` API instead, for use on platforms that have `liballoc` but not `libstd`. This
|
||||
//! configuration is currently unstable and is not guaranteed to work on all versions of Rust.
|
||||
//!
|
||||
//! To depend on `smallvec` without `libstd`, use `default-features = false` in the `smallvec`
|
||||
//! section of Cargo.toml to disable its `"std"` feature.
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
#![cfg_attr(not(feature = "std"), feature(alloc))]
|
||||
|
||||
Reference in New Issue
Block a user