mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-25 00:03:43 +00:00
Replace libstd, libcore, liballoc in docs.
This commit is contained in:
parent
f6cc345be4
commit
72067c77bd
@ -3,7 +3,7 @@
|
||||
//! This library provides smart pointers and collections for managing
|
||||
//! heap-allocated values.
|
||||
//!
|
||||
//! This library, like libcore, normally doesn’t need to be used directly
|
||||
//! This library, like core, normally doesn’t need to be used directly
|
||||
//! since its contents are re-exported in the [`std` crate](../std/index.html).
|
||||
//! Crates that use the `#![no_std]` attribute however will typically
|
||||
//! not depend on `std`, so they’d use this crate instead.
|
||||
|
@ -653,7 +653,7 @@ impl [u8] {
|
||||
///
|
||||
/// ```error
|
||||
/// error[E0207]: the type parameter `T` is not constrained by the impl trait, self type, or predica
|
||||
/// --> src/liballoc/slice.rs:608:6
|
||||
/// --> src/alloc/slice.rs:608:6
|
||||
/// |
|
||||
/// 608 | impl<T: Clone, V: Borrow<[T]>> Concat for [V] {
|
||||
/// | ^ unconstrained type parameter
|
||||
|
@ -558,7 +558,7 @@ impl Display for Arguments<'_> {
|
||||
///
|
||||
/// Derived `Debug` formats are not stable, and so may change with future Rust
|
||||
/// versions. Additionally, `Debug` implementations of types provided by the
|
||||
/// standard library (`libstd`, `libcore`, `liballoc`, etc.) are not stable, and
|
||||
/// standard library (`std`, `core`, `alloc`, etc.) are not stable, and
|
||||
/// may also change with future Rust versions.
|
||||
///
|
||||
/// # Examples
|
||||
|
@ -90,14 +90,14 @@ pub macro unreachable_2021 {
|
||||
),
|
||||
}
|
||||
|
||||
/// An internal trait used by libstd to pass data from libstd to `panic_unwind`
|
||||
/// and other panic runtimes. Not intended to be stabilized any time soon, do
|
||||
/// not use.
|
||||
/// An internal trait used by std to pass data from std to `panic_unwind` and
|
||||
/// other panic runtimes. Not intended to be stabilized any time soon, do not
|
||||
/// use.
|
||||
#[unstable(feature = "std_internals", issue = "none")]
|
||||
#[doc(hidden)]
|
||||
pub unsafe trait BoxMeUp {
|
||||
/// Take full ownership of the contents.
|
||||
/// The return type is actually `Box<dyn Any + Send>`, but we cannot use `Box` in libcore.
|
||||
/// The return type is actually `Box<dyn Any + Send>`, but we cannot use `Box` in core.
|
||||
///
|
||||
/// After this method got called, only some dummy default value is left in `self`.
|
||||
/// Calling this method twice, or calling `get` after calling this method, is an error.
|
||||
|
@ -1,8 +1,8 @@
|
||||
//! Panic support for libcore
|
||||
//! Panic support for core
|
||||
//!
|
||||
//! The core library cannot define panicking, but it does *declare* panicking. This
|
||||
//! means that the functions inside of libcore are allowed to panic, but to be
|
||||
//! useful an upstream crate must define panicking for libcore to use. The current
|
||||
//! means that the functions inside of core are allowed to panic, but to be
|
||||
//! useful an upstream crate must define panicking for core to use. The current
|
||||
//! interface for panicking is:
|
||||
//!
|
||||
//! ```
|
||||
@ -13,7 +13,7 @@
|
||||
//! This definition allows for panicking with any general message, but it does not
|
||||
//! allow for failing with a `Box<Any>` value. (`PanicInfo` just contains a `&(dyn Any + Send)`,
|
||||
//! for which we fill in a dummy value in `PanicInfo::internal_constructor`.)
|
||||
//! The reason for this is that libcore is not allowed to allocate.
|
||||
//! The reason for this is that core is not allowed to allocate.
|
||||
//!
|
||||
//! This module contains a few other panicking functions, but these are just the
|
||||
//! necessary lang items for the compiler. All panics are funneled through this
|
||||
@ -94,7 +94,7 @@ pub fn panic_nounwind(msg: &'static str) -> ! {
|
||||
// Next we define a bunch of higher-level wrappers that all bottom out in the two core functions
|
||||
// above.
|
||||
|
||||
/// The underlying implementation of libcore's `panic!` macro when no formatting is used.
|
||||
/// The underlying implementation of core's `panic!` macro when no formatting is used.
|
||||
// never inline unless panic_immediate_abort to avoid code
|
||||
// bloat at the call sites as much as possible
|
||||
#[cfg_attr(not(feature = "panic_immediate_abort"), inline(never), cold)]
|
||||
|
@ -1,8 +1,8 @@
|
||||
//! The libcore prelude
|
||||
//! The core prelude
|
||||
//!
|
||||
//! This module is intended for users of libcore which do not link to libstd as
|
||||
//! well. This module is imported by default when `#![no_std]` is used in the
|
||||
//! same manner as the standard library's prelude.
|
||||
//! This module is intended for users of core which do not link to std as well.
|
||||
//! This module is imported by default when `#![no_std]` is used in the same
|
||||
//! manner as the standard library's prelude.
|
||||
|
||||
#![stable(feature = "core_prelude", since = "1.4.0")]
|
||||
|
||||
|
@ -3,7 +3,7 @@
|
||||
//! This module contains a sorting algorithm based on Orson Peters' pattern-defeating quicksort,
|
||||
//! published at: <https://github.com/orlp/pdqsort>
|
||||
//!
|
||||
//! Unstable sorting is compatible with libcore because it doesn't allocate memory, unlike our
|
||||
//! Unstable sorting is compatible with core because it doesn't allocate memory, unlike our
|
||||
//! stable sorting implementation.
|
||||
|
||||
use crate::cmp;
|
||||
|
@ -82,11 +82,11 @@ cfg_if::cfg_if! {
|
||||
}
|
||||
|
||||
extern "C" {
|
||||
/// Handler in libstd called when a panic object is dropped outside of
|
||||
/// Handler in std called when a panic object is dropped outside of
|
||||
/// `catch_unwind`.
|
||||
fn __rust_drop_panic() -> !;
|
||||
|
||||
/// Handler in libstd called when a foreign exception is caught.
|
||||
/// Handler in std called when a foreign exception is caught.
|
||||
fn __rust_foreign_exception() -> !;
|
||||
}
|
||||
|
||||
|
@ -15,9 +15,9 @@ use std::ops::BitXor;
|
||||
/// Type alias for a hashmap using the `fx` hash algorithm.
|
||||
pub type FxHashMap<K, V> = HashMap<K, V, BuildHasherDefault<FxHasher>>;
|
||||
|
||||
/// A speedy hash algorithm for use within rustc. The hashmap in liballoc
|
||||
/// by default uses SipHash which isn't quite as speedy as we want. In the
|
||||
/// compiler we're not really worried about DOS attempts, so we use a fast
|
||||
/// A speedy hash algorithm for use within rustc. The hashmap in alloc by
|
||||
/// default uses SipHash which isn't quite as speedy as we want. In the compiler
|
||||
/// we're not really worried about DOS attempts, so we use a fast
|
||||
/// non-cryptographic hash.
|
||||
///
|
||||
/// This is the same as the algorithm used by Firefox -- which is a homespun
|
||||
|
@ -23,10 +23,10 @@
|
||||
//!
|
||||
//! ## Platform support
|
||||
//!
|
||||
//! Not all platforms that libstd compiles for support capturing backtraces.
|
||||
//! Some platforms simply do nothing when capturing a backtrace. To check
|
||||
//! whether the platform supports capturing backtraces you can consult the
|
||||
//! `BacktraceStatus` enum as a result of `Backtrace::status`.
|
||||
//! Not all platforms that std compiles for support capturing backtraces. Some
|
||||
//! platforms simply do nothing when capturing a backtrace. To check whether the
|
||||
//! platform supports capturing backtraces you can consult the `BacktraceStatus`
|
||||
//! enum as a result of `Backtrace::status`.
|
||||
//!
|
||||
//! Like above with accuracy platform support is done on a best effort basis.
|
||||
//! Sometimes libraries might not be available at runtime or something may go
|
||||
|
@ -517,7 +517,7 @@ pub fn panicking() -> bool {
|
||||
!panic_count::count_is_zero()
|
||||
}
|
||||
|
||||
/// Entry point of panics from the libcore crate (`panic_impl` lang item).
|
||||
/// Entry point of panics from the core crate (`panic_impl` lang item).
|
||||
#[cfg(not(test))]
|
||||
#[panic_handler]
|
||||
pub fn begin_panic_handler(info: &PanicInfo<'_>) -> ! {
|
||||
|
@ -1,7 +1,7 @@
|
||||
//! Android ABI-compatibility module
|
||||
//!
|
||||
//! The ABI of Android has changed quite a bit over time, and libstd attempts to
|
||||
//! be both forwards and backwards compatible as much as possible. We want to
|
||||
//! The ABI of Android has changed quite a bit over time, and std attempts to be
|
||||
//! both forwards and backwards compatible as much as possible. We want to
|
||||
//! always work with the most recent version of Android, but we also want to
|
||||
//! work with older versions of Android for whenever projects need to.
|
||||
//!
|
||||
|
@ -1,9 +1,8 @@
|
||||
//! Support for "weak linkage" to symbols on Unix
|
||||
//!
|
||||
//! Some I/O operations we do in libstd require newer versions of OSes but we
|
||||
//! need to maintain binary compatibility with older releases for now. In order
|
||||
//! to use the new functionality when available we use this module for
|
||||
//! detection.
|
||||
//! Some I/O operations we do in std require newer versions of OSes but we need
|
||||
//! to maintain binary compatibility with older releases for now. In order to
|
||||
//! use the new functionality when available we use this module for detection.
|
||||
//!
|
||||
//! One option to use here is weak linkage, but that is unfortunately only
|
||||
//! really workable with ELF. Otherwise, use dlsym to get the symbol value at
|
||||
|
@ -111,7 +111,7 @@ unsafe fn _print_fmt(fmt: &mut fmt::Formatter<'_>, print_fmt: PrintFmt) -> fmt::
|
||||
}
|
||||
|
||||
/// Fixed frame used to clean the backtrace with `RUST_BACKTRACE=1`. Note that
|
||||
/// this is only inline(never) when backtraces in libstd are enabled, otherwise
|
||||
/// this is only inline(never) when backtraces in std are enabled, otherwise
|
||||
/// it's fine to optimize away.
|
||||
#[cfg_attr(feature = "backtrace", inline(never))]
|
||||
pub fn __rust_begin_short_backtrace<F, T>(f: F) -> T
|
||||
@ -127,7 +127,7 @@ where
|
||||
}
|
||||
|
||||
/// Fixed frame used to clean the backtrace with `RUST_BACKTRACE=1`. Note that
|
||||
/// this is only inline(never) when backtraces in libstd are enabled, otherwise
|
||||
/// this is only inline(never) when backtraces in std are enabled, otherwise
|
||||
/// it's fine to optimize away.
|
||||
#[cfg_attr(feature = "backtrace", inline(never))]
|
||||
pub fn __rust_end_short_backtrace<F, T>(f: F) -> T
|
||||
|
@ -1,4 +1,4 @@
|
||||
//! These tests just check that the macros are available in libstd.
|
||||
//! These tests just check that the macros are available in std.
|
||||
|
||||
#![cfg_attr(
|
||||
any(
|
||||
|
Loading…
Reference in New Issue
Block a user