rust/library/core/Cargo.toml

[package]
name = "core"
version = "0.0.0"
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang/rust.git"
description = "The Rust Core Library"
autotests = false
autobenches = false
# If you update this, be sure to update it in a bunch of other places too!
# As of 2024, it was src/tools/opt-dist, the core-no-fp-fmt-parse test and
# the version of the prelude imported in core/lib.rs.
edition = "2021"

[lib]
test = false
bench = false

[[test]]
name = "coretests"
path = "tests/lib.rs"

[[bench]]
name = "corebenches"
path = "benches/lib.rs"
test = true

[dev-dependencies]
rand = { version = "0.8.5", default-features = false }
rand_xorshift = { version = "0.3.0", default-features = false }

[features]
# Make panics and failed asserts immediately abort without formatting any message
panic_immediate_abort = []
# Make `RefCell` store additional debugging information, which is printed out when
# a borrow error occurs
debug_refcell = []
bootstrap: Add a bunch of Cargo.toml files These describe the structure of all our crate dependencies. 2016-01-21 17:19:23 -06:00			`[package]`
			`name = "core"`
			`version = "0.0.0"`
Add license metadata for std dependencies 2021-02-20 12:18:01 -06:00			`license = "MIT OR Apache-2.0"`
			`repository = "https://github.com/rust-lang/rust.git"`
			`description = "The Rust Core Library"`
Switch to 1.26 bootstrap compiler 2018-05-10 13:02:19 -05:00			`autotests = false`
			`autobenches = false`
Build libcore as 2021 in a few more places The `Cargo.toml` has `edition = "2021"`, so that's what these command lines should use too. 2022-02-02 00:48:04 -06:00			`# If you update this, be sure to update it in a bunch of other places too!`
Import the 2021 prelude in the core crate 2024-03-25 13:02:02 -05:00			`# As of 2024, it was src/tools/opt-dist, the core-no-fp-fmt-parse test and`
			`# the version of the prelude imported in core/lib.rs.`
Switch all libraries to the 2021 edition 2021-12-17 07:53:28 -06:00			`edition = "2021"`
bootstrap: Add a bunch of Cargo.toml files These describe the structure of all our crate dependencies. 2016-01-21 17:19:23 -06:00
			`[lib]`
			`test = false`
rustbuild: Point to core and collections's external benchmarks. 2016-11-25 15:13:59 -06:00			`bench = false`
rustbuild: Add support for crate tests + doctests This commit adds support to rustbuild to run crate unit tests (those defined by `#[test]`) as well as documentation tests. All tests are powered by `cargo test` under the hood. Each step requires the `libtest` library is built for that corresponding stage. Ideally the `test` crate would be a dev-dependency, but for now it's just easier to ensure that we sequence everything in the right order. Currently no filtering is implemented, so there's not actually a method of testing only libstd or only libcore, but rather entire swaths of crates are tested all at once. A few points of note here are: * The `coretest` and `collectionstest` crates are just listed as `[[test]]` entires for `cargo test` to naturally pick up. This mean that `cargo test -p core` actually runs all the tests for libcore. * Libraries that aren't tested all mention `test = false` in their `Cargo.toml` * Crates aren't currently allowed to have dev-dependencies due to rust-lang/cargo#860, but we can likely alleviate this restriction once workspaces are implemented. cc #31590 2016-04-29 16:23:15 -05:00
			`[[test]]`
Move libXtest into libX/tests This change moves: 1. `libcoretest` into `libcore/tests` 2. `libcollectionstest` into `libcollections/tests` This is a follow-up to #39561. 2017-04-03 09:53:04 -05:00			`name = "coretests"`
mv std libs to library/ 2020-06-11 21:31:49 -05:00			`path = "tests/lib.rs"`
rustbuild: Point to core and collections's external benchmarks. 2016-11-25 15:13:59 -06:00
Extract libcore benchmarks to a separate folder 2017-02-03 17:04:22 -06:00			`[[bench]]`
Extract collections benchmarks to libcollections/benches And libcore/benches 2017-02-06 04:38:47 -06:00			`name = "corebenches"`
mv std libs to library/ 2020-06-11 21:31:49 -05:00			`path = "benches/lib.rs"`
Ensure std benchmarks get tested. 2020-06-08 11:09:21 -05:00			`test = true`
Update Cargo submodule Required moving all fulldeps tests depending on `rand` to different locations as now there's multiple `rand` crates that can't be implicitly linked against. 2018-02-26 11:07:16 -06:00
			`[dev-dependencies]`
Update rand in the stdlib tests, and remove the getrandom feature from it 2022-11-20 18:55:41 -06:00			`rand = { version = "0.8.5", default-features = false }`
			`rand_xorshift = { version = "0.3.0", default-features = false }`
Add libstd and libcore Cargo features "panic_immediate_abort" It stop asserts and panics from libstd to automatically include string output and formatting code. Use case: developing static executables smaller than 50 kilobytes, where usual formatting code is excessive while keeping debuggability in debug mode. May resolve #54981. 2018-11-29 15:06:10 -06:00
			`[features]`
			`# Make panics and failed asserts immediately abort without formatting any message`
			`panic_immediate_abort = []`
Add `debug-refcell` feature to libcore See https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Attaching.20backtraces.20to.20RefCell/near/226273614 for some background discussion This PR adds a new off-by-default feature `debug-refcell` to libcore. When enabled, this feature stores additional debugging information in `RefCell`. This information is included in the panic message when `borrow()` or `borrow_mut()` panics, to make it easier to track down the source of the issue. Currently, we store the caller location for the earliest active borrow. This has a number of advantages: * There is only a constant amount of overhead per `RefCell` * We don't need any heap memory, so it can easily be implemented in core * Since we are storing the earliest active borrow, we don't need any extra logic in the `Drop` implementation for `Ref` and `RefMut` Limitations: * We only store the caller location, not a full `Backtrace`. Until we get support for `Backtrace` in libcore, this is the best tha we can do. * The captured location is only displayed when `borrow()` or `borrow_mut()` panics. If a crate calls `try_borrow().unwrap()` or `try_borrow_mut().unwrap()`, this extra information will be lost. To make testing easier, I've enabled the `debug-refcell` feature by default. I'm not sure how to write a test for this feature - we would need to rebuild core from the test framework, and create a separate sysroot. Since this feature will be off-by-default, users will need to use `xargo` or `cargo -Z build-std` to enable this feature. For users using a prebuilt standard library, this feature will be disabled with zero overhead. I've created a simple test program: ```rust use std::cell::RefCell; fn main() { let _ = std::panic::catch_unwind(\|\| { let val = RefCell::new(true); let _first = val.borrow(); let _second = val.borrow(); let _third = val.borrow_mut(); }); let _ = std::panic::catch_unwind(\|\| { let val = RefCell::new(true); let first = val.borrow_mut(); drop(first); let _second = val.borrow_mut(); let _thid = val.borrow(); }); } ``` which produces the following output: ``` thread 'main' panicked at 'already borrowed: BorrowMutError { location: Location { file: "refcell_test.rs", line: 6, col: 26 } }', refcell_test.rs:8:26 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace thread 'main' panicked at 'already mutably borrowed: BorrowError { location: Location { file: "refcell_test.rs", line: 16, col: 27 } }', refcell_test.rs:18:25 ``` 2021-02-17 20:30:39 -06:00			# Make `RefCell` store additional debugging information, which is printed out when
			`# a borrow error occurs`
			`debug_refcell = []`