nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-06-06 20:28:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
2a434286a9
rust/library/std/src/prelude/v1.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

105 lines
3.5 KiB
Rust
Raw Normal View History

std: Update crate docs Attempted to organize them in a way more relevant to what newbies would be interested in hearing.
2015-05-08 22:15:03 +00:00
//! The first version of the prelude of The Rust Standard Library.
Clean up the prelude docs This mostly brings them in line with existing linking convention, but also has some minor re-wording. The text at the top has been re-focused, by starting out with what the prelude does, rather than starting from injecting std. Also, it now mentions that other preludes exist. Part of https://github.com/rust-lang/rust/issues/29369
2015-11-11 20:22:23 +00:00
//!
Use intra-doc links. Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-02-25 11:41:39 +00:00
//! See the [module-level documentation](super) for more.
std: Stabilize the prelude module This commit is an implementation of [RFC 503][rfc] which is a stabilization story for the prelude. Most of the RFC was directly applied, removing reexports. Some reexports are kept around, however: * `range` remains until range syntax has landed to reduce churn. * `Path` and `GenericPath` remain until path reform lands. This is done to prevent many imports of `GenericPath` which will soon be removed. * All `io` traits remain until I/O reform lands so imports can be rewritten all at once to `std::io::prelude::*`. This is a breaking change because many prelude reexports have been removed, and the RFC can be consulted for the exact list of removed reexports, as well as to find the locations of where to import them. [rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0503-prelude-stabilization.md [breaking-change] Closes #20068
2014-12-22 17:04:23 +00:00
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#![stable(feature = "rust1", since = "1.0.0")]
std: Stabilize the prelude module This commit is an implementation of [RFC 503][rfc] which is a stabilization story for the prelude. Most of the RFC was directly applied, removing reexports. Some reexports are kept around, however: * `range` remains until range syntax has landed to reduce churn. * `Path` and `GenericPath` remain until path reform lands. This is done to prevent many imports of `GenericPath` which will soon be removed. * All `io` traits remain until I/O reform lands so imports can be rewritten all at once to `std::io::prelude::*`. This is a breaking change because many prelude reexports have been removed, and the RFC can be consulted for the exact list of removed reexports, as well as to find the locations of where to import them. [rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0503-prelude-stabilization.md [breaking-change] Closes #20068
2014-12-22 17:04:23 +00:00
Reexport -> re-export in prose and documentation comments
2018-01-12 21:41:25 +00:00
// Re-exported core operators
Introduce built-in macros through libcore
2019-06-20 08:52:31 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
#[doc(no_inline)]
pub use crate::marker::{Send, Sized, Sync, Unpin};
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
libstd => 2018
2019-02-10 19:23:21 +00:00
pub use crate::ops::{Drop, Fn, FnMut, FnOnce};
Test fixes and rebase conflicts
2015-01-06 23:57:50 +00:00
Reexport -> re-export in prose and documentation comments
2018-01-12 21:41:25 +00:00
// Re-exported functions
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
libstd => 2018
2019-02-10 19:23:21 +00:00
pub use crate::mem::drop;
std: Stabilize the prelude module This commit is an implementation of [RFC 503][rfc] which is a stabilization story for the prelude. Most of the RFC was directly applied, removing reexports. Some reexports are kept around, however: * `range` remains until range syntax has landed to reduce churn. * `Path` and `GenericPath` remain until path reform lands. This is done to prevent many imports of `GenericPath` which will soon be removed. * All `io` traits remain until I/O reform lands so imports can be rewritten all at once to `std::io::prelude::*`. This is a breaking change because many prelude reexports have been removed, and the RFC can be consulted for the exact list of removed reexports, as well as to find the locations of where to import them. [rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0503-prelude-stabilization.md [breaking-change] Closes #20068
2014-12-22 17:04:23 +00:00
Reexport -> re-export in prose and documentation comments
2018-01-12 21:41:25 +00:00
// Re-exported types and traits
std: Add Default/IntoIterator/ToOwned to the prelude This is an implementation of [RFC 1030][rfc] which adds these traits to the prelude and additionally removes all inherent `into_iter` methods on collections in favor of the trait implementation (which is now accessible by default). [rfc]: https://github.com/rust-lang/rfcs/pull/1030 This is technically a breaking change due to the prelude additions and removal of inherent methods, but it is expected that essentially no code breaks in practice. [breaking-change] Closes #24538
2015-04-17 21:31:30 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
Format libstd with rustfmt This commit applies rustfmt with rust-lang/rust's default settings to files in src/libstd *that are not involved in any currently open PR* to minimize merge conflicts. THe list of files involved in open PRs was determined by querying GitHub's GraphQL API with this script: https://gist.github.com/dtolnay/aa9c34993dc051a4f344d1b10e4487e8 With the list of files from the script in outstanding_files, the relevant commands were: $ find src/libstd -name '*.rs' \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ rg libstd outstanding_files | xargs git checkout -- Repeating this process several months apart should get us coverage of most of the rest of libstd. To confirm no funny business: $ git checkout $THIS_COMMIT^ $ git show --pretty= --name-only $THIS_COMMIT \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ git diff $THIS_COMMIT # there should be no difference
2019-11-27 18:29:00 +00:00
pub use crate::convert::{AsMut, AsRef, From, Into};
std: Add Default/IntoIterator/ToOwned to the prelude This is an implementation of [RFC 1030][rfc] which adds these traits to the prelude and additionally removes all inherent `into_iter` methods on collections in favor of the trait implementation (which is now accessible by default). [rfc]: https://github.com/rust-lang/rfcs/pull/1030 This is technically a breaking change due to the prelude additions and removal of inherent methods, but it is expected that essentially no code breaks in practice. [breaking-change] Closes #24538
2015-04-17 21:31:30 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
Format libstd with rustfmt This commit applies rustfmt with rust-lang/rust's default settings to files in src/libstd *that are not involved in any currently open PR* to minimize merge conflicts. THe list of files involved in open PRs was determined by querying GitHub's GraphQL API with this script: https://gist.github.com/dtolnay/aa9c34993dc051a4f344d1b10e4487e8 With the list of files from the script in outstanding_files, the relevant commands were: $ find src/libstd -name '*.rs' \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ rg libstd outstanding_files | xargs git checkout -- Repeating this process several months apart should get us coverage of most of the rest of libstd. To confirm no funny business: $ git checkout $THIS_COMMIT^ $ git show --pretty= --name-only $THIS_COMMIT \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ git diff $THIS_COMMIT # there should be no difference
2019-11-27 18:29:00 +00:00
pub use crate::iter::{DoubleEndedIterator, ExactSizeIterator};
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
Format libstd with rustfmt This commit applies rustfmt with rust-lang/rust's default settings to files in src/libstd *that are not involved in any currently open PR* to minimize merge conflicts. THe list of files involved in open PRs was determined by querying GitHub's GraphQL API with this script: https://gist.github.com/dtolnay/aa9c34993dc051a4f344d1b10e4487e8 With the list of files from the script in outstanding_files, the relevant commands were: $ find src/libstd -name '*.rs' \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ rg libstd outstanding_files | xargs git checkout -- Repeating this process several months apart should get us coverage of most of the rest of libstd. To confirm no funny business: $ git checkout $THIS_COMMIT^ $ git show --pretty= --name-only $THIS_COMMIT \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ git diff $THIS_COMMIT # there should be no difference
2019-11-27 18:29:00 +00:00
pub use crate::iter::{Extend, IntoIterator, Iterator};
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
Format libstd with rustfmt This commit applies rustfmt with rust-lang/rust's default settings to files in src/libstd *that are not involved in any currently open PR* to minimize merge conflicts. THe list of files involved in open PRs was determined by querying GitHub's GraphQL API with this script: https://gist.github.com/dtolnay/aa9c34993dc051a4f344d1b10e4487e8 With the list of files from the script in outstanding_files, the relevant commands were: $ find src/libstd -name '*.rs' \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ rg libstd outstanding_files | xargs git checkout -- Repeating this process several months apart should get us coverage of most of the rest of libstd. To confirm no funny business: $ git checkout $THIS_COMMIT^ $ git show --pretty= --name-only $THIS_COMMIT \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ git diff $THIS_COMMIT # there should be no difference
2019-11-27 18:29:00 +00:00
pub use crate::option::Option::{self, None, Some};
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
Format libstd with rustfmt This commit applies rustfmt with rust-lang/rust's default settings to files in src/libstd *that are not involved in any currently open PR* to minimize merge conflicts. THe list of files involved in open PRs was determined by querying GitHub's GraphQL API with this script: https://gist.github.com/dtolnay/aa9c34993dc051a4f344d1b10e4487e8 With the list of files from the script in outstanding_files, the relevant commands were: $ find src/libstd -name '*.rs' \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ rg libstd outstanding_files | xargs git checkout -- Repeating this process several months apart should get us coverage of most of the rest of libstd. To confirm no funny business: $ git checkout $THIS_COMMIT^ $ git show --pretty= --name-only $THIS_COMMIT \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ git diff $THIS_COMMIT # there should be no difference
2019-11-27 18:29:00 +00:00
pub use crate::result::Result::{self, Err, Ok};
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
Introduce built-in macros through libcore
2019-06-20 08:52:31 +00:00
// Re-exported built-in macros
#[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
Deprecate the asm! macro
2020-04-10 16:34:30 +00:00
#[allow(deprecated)]
Introduce built-in macros through libcore
2019-06-20 08:52:31 +00:00
#[doc(no_inline)]
pub use core::prelude::v1::{
Move asm! and global_asm! to core::arch
2021-07-17 18:48:00 +00:00
assert, cfg, column, compile_error, concat, concat_idents, env, file, format_args,
Remove deprecated LLVM-style inline assembly
2022-01-12 00:00:00 +00:00
format_args_nl, include, include_bytes, include_str, line, log_syntax, module_path, option_env,
stringify, trace_macros, Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd,
Introduce built-in macros through libcore
2019-06-20 08:52:31 +00:00
};
Implement concat_bytes! The tracking issue for this is #87555.
2021-07-29 17:00:55 +00:00
#[unstable(
feature = "concat_bytes",
issue = "87555",
reason = "`concat_bytes` is not stable enough for use and is subject to change"
)]
#[doc(no_inline)]
pub use core::prelude::v1::concat_bytes;
Make the documentation of builtin macro attributes accessible - Do not `#[doc(hidden)]` the `#[derive]` macro attribute - Add a link to the reference section to `derive`'s inherent docs - Do the same for `#[test]` and `#[global_allocator]` - Fix `GlobalAlloc` link (why is it on `core` and not `alloc`?) - Try `no_inline`-ing the `std` reexports from `core` - Revert "Try `no_inline`-ing the `std` reexports from `core`" - Address PR review - Also document the unstable macros
2021-12-31 12:32:03 +00:00
// Do not `doc(inline)` these `doc(hidden)` items.
Introduce built-in macros through libcore
2019-06-20 08:52:31 +00:00
#[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
Make the documentation of builtin macro attributes accessible - Do not `#[doc(hidden)]` the `#[derive]` macro attribute - Add a link to the reference section to `derive`'s inherent docs - Do the same for `#[test]` and `#[global_allocator]` - Fix `GlobalAlloc` link (why is it on `core` and not `alloc`?) - Try `no_inline`-ing the `std` reexports from `core` - Revert "Try `no_inline`-ing the `std` reexports from `core`" - Address PR review - Also document the unstable macros
2021-12-31 12:32:03 +00:00
#[allow(deprecated)]
pub use core::prelude::v1::{RustcDecodable, RustcEncodable};
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
Make the documentation of builtin macro attributes accessible - Do not `#[doc(hidden)]` the `#[derive]` macro attribute - Add a link to the reference section to `derive`'s inherent docs - Do the same for `#[test]` and `#[global_allocator]` - Fix `GlobalAlloc` link (why is it on `core` and not `alloc`?) - Try `no_inline`-ing the `std` reexports from `core` - Revert "Try `no_inline`-ing the `std` reexports from `core`" - Address PR review - Also document the unstable macros
2021-12-31 12:32:03 +00:00
// Do not `doc(no_inline)` so that they become doc items on their own
// (no public module for them to be re-exported from).
Rewrite implementation of `#[alloc_error_handler]` The new implementation doesn't use weak lang items and instead changes `#[alloc_error_handler]` to an attribute macro just like `#[global_allocator]`. The attribute will generate the `__rg_oom` function which is called by the compiler-generated `__rust_alloc_error_handler`. If no `__rg_oom` function is defined in any crate then the compiler shim will call `__rdl_oom` in the alloc crate which will simply panic. This also fixes link errors with `-C link-dead-code` with `default_alloc_error_handler`: `__rg_oom` was previously defined in the alloc crate and would attempt to reference the `oom` lang item, even if it didn't exist. This worked as long as `__rg_oom` was excluded from linking since it was not called. This is a prerequisite for the stabilization of `default_alloc_error_handler` (#102318).
2022-10-14 01:24:58 +00:00
#[cfg(not(bootstrap))]
#[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
pub use core::prelude::v1::alloc_error_handler;
expand/resolve: Turn `#[derive]` into a regular macro attribute
2020-11-14 11:47:14 +00:00
#[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
Make the documentation of builtin macro attributes accessible - Do not `#[doc(hidden)]` the `#[derive]` macro attribute - Add a link to the reference section to `derive`'s inherent docs - Do the same for `#[test]` and `#[global_allocator]` - Fix `GlobalAlloc` link (why is it on `core` and not `alloc`?) - Try `no_inline`-ing the `std` reexports from `core` - Revert "Try `no_inline`-ing the `std` reexports from `core`" - Address PR review - Also document the unstable macros
2021-12-31 12:32:03 +00:00
pub use core::prelude::v1::{bench, derive, global_allocator, test, test_case};
expand/resolve: Turn `#[derive]` into a regular macro attribute
2020-11-14 11:47:14 +00:00
Add the `#[derive_const]` attribute
2022-09-20 11:55:07 +00:00
#[unstable(feature = "derive_const", issue = "none")]
#[cfg(not(bootstrap))]
pub use core::prelude::v1::derive_const;
Make the documentation of builtin macro attributes accessible - Do not `#[doc(hidden)]` the `#[derive]` macro attribute - Add a link to the reference section to `derive`'s inherent docs - Do the same for `#[test]` and `#[global_allocator]` - Fix `GlobalAlloc` link (why is it on `core` and not `alloc`?) - Try `no_inline`-ing the `std` reexports from `core` - Revert "Try `no_inline`-ing the `std` reexports from `core`" - Address PR review - Also document the unstable macros
2021-12-31 12:32:03 +00:00
// Do not `doc(no_inline)` either.
builtin_macros: Add attribute macro `#[cfg_accessible(path)]`
2020-03-09 21:56:20 +00:00
#[unstable(
feature = "cfg_accessible",
issue = "64797",
reason = "`cfg_accessible` is not fully implemented"
)]
pub use core::prelude::v1::cfg_accessible;
Make the documentation of builtin macro attributes accessible - Do not `#[doc(hidden)]` the `#[derive]` macro attribute - Add a link to the reference section to `derive`'s inherent docs - Do the same for `#[test]` and `#[global_allocator]` - Fix `GlobalAlloc` link (why is it on `core` and not `alloc`?) - Try `no_inline`-ing the `std` reexports from `core` - Revert "Try `no_inline`-ing the `std` reexports from `core`" - Address PR review - Also document the unstable macros
2021-12-31 12:32:03 +00:00
// Do not `doc(no_inline)` either.
Implement built-in attribute macro `#[cfg_eval]`
2021-03-06 18:33:02 +00:00
#[unstable(
feature = "cfg_eval",
issue = "82679",
reason = "`cfg_eval` is a recently implemented feature"
)]
pub use core::prelude::v1::cfg_eval;
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
// The file so far is equivalent to src/libcore/prelude/v1.rs,
// and below to src/liballoc/prelude.rs.
// Those files are duplicated rather than using glob imports
// because we want docs to show these re-exports as pointing to within `std`.
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
Format libstd with rustfmt This commit applies rustfmt with rust-lang/rust's default settings to files in src/libstd *that are not involved in any currently open PR* to minimize merge conflicts. THe list of files involved in open PRs was determined by querying GitHub's GraphQL API with this script: https://gist.github.com/dtolnay/aa9c34993dc051a4f344d1b10e4487e8 With the list of files from the script in outstanding_files, the relevant commands were: $ find src/libstd -name '*.rs' \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ rg libstd outstanding_files | xargs git checkout -- Repeating this process several months apart should get us coverage of most of the rest of libstd. To confirm no funny business: $ git checkout $THIS_COMMIT^ $ git show --pretty= --name-only $THIS_COMMIT \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ git diff $THIS_COMMIT # there should be no difference
2019-11-27 18:29:00 +00:00
pub use crate::borrow::ToOwned;
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
Format libstd with rustfmt This commit applies rustfmt with rust-lang/rust's default settings to files in src/libstd *that are not involved in any currently open PR* to minimize merge conflicts. THe list of files involved in open PRs was determined by querying GitHub's GraphQL API with this script: https://gist.github.com/dtolnay/aa9c34993dc051a4f344d1b10e4487e8 With the list of files from the script in outstanding_files, the relevant commands were: $ find src/libstd -name '*.rs' \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ rg libstd outstanding_files | xargs git checkout -- Repeating this process several months apart should get us coverage of most of the rest of libstd. To confirm no funny business: $ git checkout $THIS_COMMIT^ $ git show --pretty= --name-only $THIS_COMMIT \ | xargs rustfmt --edition=2018 --unstable-features --skip-children $ git diff $THIS_COMMIT # there should be no difference
2019-11-27 18:29:00 +00:00
pub use crate::boxed::Box;
impl<T> [T]
2015-03-11 04:13:29 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
libstd => 2018
2019-02-10 19:23:21 +00:00
pub use crate::string::{String, ToString};
grandfathered -> rust1
2015-01-24 05:48:20 +00:00
#[stable(feature = "rust1", since = "1.0.0")]
Reformat std prelude source to show it is the sum of core and alloc preludes
2018-07-07 21:16:27 +00:00
#[doc(no_inline)]
libstd => 2018
2019-02-10 19:23:21 +00:00
pub use crate::vec::Vec;
Reference in New Issue Copy Permalink