1 //! # The Rust Standard Library
3 //! The Rust Standard Library is the foundation of portable Rust software, a
4 //! set of minimal and battle-tested shared abstractions for the [broader Rust
5 //! ecosystem][crates.io]. It offers core types, like [`Vec<T>`] and
6 //! [`Option<T>`], library-defined [operations on language
7 //! primitives](#primitives), [standard macros](#macros), [I/O] and
8 //! [multithreading], among [many other things][other].
10 //! `std` is available to all Rust crates by default. Therefore, the
11 //! standard library can be accessed in [`use`] statements through the path
12 //! `std`, as in [`use std::env`].
14 //! # How to read this documentation
16 //! If you already know the name of what you are looking for, the fastest way to
17 //! find it is to use the <a href="#" onclick="focusSearchBar();">search
18 //! bar</a> at the top of the page.
20 //! Otherwise, you may want to jump to one of these useful sections:
22 //! * [`std::*` modules](#modules)
23 //! * [Primitive types](#primitives)
24 //! * [Standard macros](#macros)
25 //! * [The Rust Prelude]
27 //! If this is your first time, the documentation for the standard library is
28 //! written to be casually perused. Clicking on interesting things should
29 //! generally lead you to interesting places. Still, there are important bits
30 //! you don't want to miss, so read on for a tour of the standard library and
31 //! its documentation!
33 //! Once you are familiar with the contents of the standard library you may
34 //! begin to find the verbosity of the prose distracting. At this stage in your
35 //! development you may want to press the `[-]` button near the top of the
36 //! page to collapse it into a more skimmable view.
38 //! While you are looking at that `[-]` button also notice the `source`
39 //! link. Rust's API documentation comes with the source code and you are
40 //! encouraged to read it. The standard library source is generally high
41 //! quality and a peek behind the curtains is often enlightening.
43 //! # What is in the standard library documentation?
45 //! First of all, The Rust Standard Library is divided into a number of focused
46 //! modules, [all listed further down this page](#modules). These modules are
47 //! the bedrock upon which all of Rust is forged, and they have mighty names
48 //! like [`std::slice`] and [`std::cmp`]. Modules' documentation typically
49 //! includes an overview of the module along with examples, and are a smart
50 //! place to start familiarizing yourself with the library.
52 //! Second, implicit methods on [primitive types] are documented here. This can
53 //! be a source of confusion for two reasons:
55 //! 1. While primitives are implemented by the compiler, the standard library
56 //! implements methods directly on the primitive types (and it is the only
57 //! library that does so), which are [documented in the section on
58 //! primitives](#primitives).
59 //! 2. The standard library exports many modules *with the same name as
60 //! primitive types*. These define additional items related to the primitive
61 //! type, but not the all-important methods.
63 //! So for example there is a [page for the primitive type
64 //! `i32`](primitive::i32) that lists all the methods that can be called on
65 //! 32-bit integers (very useful), and there is a [page for the module
66 //! `std::i32`] that documents the constant values [`MIN`] and [`MAX`] (rarely
69 //! Note the documentation for the primitives [`str`] and [`[T]`][prim@slice] (also
70 //! called 'slice'). Many method calls on [`String`] and [`Vec<T>`] are actually
71 //! calls to methods on [`str`] and [`[T]`][prim@slice] respectively, via [deref
72 //! coercions][deref-coercions].
74 //! Third, the standard library defines [The Rust Prelude], a small collection
75 //! of items - mostly traits - that are imported into every module of every
76 //! crate. The traits in the prelude are pervasive, making the prelude
77 //! documentation a good entry point to learning about the library.
79 //! And finally, the standard library exports a number of standard macros, and
80 //! [lists them on this page](#macros) (technically, not all of the standard
81 //! macros are defined by the standard library - some are defined by the
82 //! compiler - but they are documented here the same). Like the prelude, the
83 //! standard macros are imported by default into all crates.
85 //! # Contributing changes to the documentation
87 //! Check out the rust contribution guidelines [here](
88 //! https://rustc-dev-guide.rust-lang.org/contributing.html#writing-documentation).
89 //! The source for this documentation can be found on
90 //! [GitHub](https://github.com/rust-lang/rust).
91 //! To contribute changes, make sure you read the guidelines first, then submit
92 //! pull-requests for your suggested changes.
94 //! Contributions are appreciated! If you see a part of the docs that can be
95 //! improved, submit a PR, or chat with us first on [Discord][rust-discord]
98 //! # A Tour of The Rust Standard Library
100 //! The rest of this crate documentation is dedicated to pointing out notable
101 //! features of The Rust Standard Library.
103 //! ## Containers and collections
105 //! The [`option`] and [`result`] modules define optional and error-handling
106 //! types, [`Option<T>`] and [`Result<T, E>`]. The [`iter`] module defines
107 //! Rust's iterator trait, [`Iterator`], which works with the [`for`] loop to
108 //! access collections.
110 //! The standard library exposes three common ways to deal with contiguous
111 //! regions of memory:
113 //! * [`Vec<T>`] - A heap-allocated *vector* that is resizable at runtime.
114 //! * [`[T; N]`][prim@array] - An inline *array* with a fixed size at compile time.
115 //! * [`[T]`][prim@slice] - A dynamically sized *slice* into any other kind of contiguous
116 //! storage, whether heap-allocated or not.
118 //! Slices can only be handled through some kind of *pointer*, and as such come
119 //! in many flavors such as:
121 //! * `&[T]` - *shared slice*
122 //! * `&mut [T]` - *mutable slice*
123 //! * [`Box<[T]>`][owned slice] - *owned slice*
125 //! [`str`], a UTF-8 string slice, is a primitive type, and the standard library
126 //! defines many methods for it. Rust [`str`]s are typically accessed as
127 //! immutable references: `&str`. Use the owned [`String`] for building and
128 //! mutating strings.
130 //! For converting to strings use the [`format!`] macro, and for converting from
131 //! strings use the [`FromStr`] trait.
133 //! Data may be shared by placing it in a reference-counted box or the [`Rc`]
134 //! type, and if further contained in a [`Cell`] or [`RefCell`], may be mutated
135 //! as well as shared. Likewise, in a concurrent setting it is common to pair an
136 //! atomically-reference-counted box, [`Arc`], with a [`Mutex`] to get the same
139 //! The [`collections`] module defines maps, sets, linked lists and other
140 //! typical collection types, including the common [`HashMap<K, V>`].
142 //! ## Platform abstractions and I/O
144 //! Besides basic data types, the standard library is largely concerned with
145 //! abstracting over differences in common platforms, most notably Windows and
146 //! Unix derivatives.
148 //! Common types of I/O, including [files], [TCP], [UDP], are defined in the
149 //! [`io`], [`fs`], and [`net`] modules.
151 //! The [`thread`] module contains Rust's threading abstractions. [`sync`]
152 //! contains further primitive shared memory types, including [`atomic`] and
153 //! [`mpsc`], which contains the channel types for message passing.
156 //! [`MIN`]: i32::MIN
157 //! [`MAX`]: i32::MAX
158 //! [page for the module `std::i32`]: crate::i32
159 //! [TCP]: net::TcpStream
160 //! [The Rust Prelude]: prelude
161 //! [UDP]: net::UdpSocket
162 //! [`Arc`]: sync::Arc
163 //! [owned slice]: boxed
164 //! [`Cell`]: cell::Cell
165 //! [`FromStr`]: str::FromStr
166 //! [`HashMap<K, V>`]: collections::HashMap
167 //! [`Mutex`]: sync::Mutex
168 //! [`Option<T>`]: option::Option
170 //! [`RefCell`]: cell::RefCell
171 //! [`Result<T, E>`]: result::Result
172 //! [`Vec<T>`]: vec::Vec
173 //! [`atomic`]: sync::atomic
174 //! [`for`]: ../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
175 //! [`str`]: prim@str
176 //! [`mpsc`]: sync::mpsc
177 //! [`std::cmp`]: cmp
178 //! [`std::slice`]: mod@slice
179 //! [`use std::env`]: env/index.html
180 //! [`use`]: ../book/ch07-02-defining-modules-to-control-scope-and-privacy.html
181 //! [crates.io]: https://crates.io
182 //! [deref-coercions]: ../book/ch15-02-deref.html#implicit-deref-coercions-with-functions-and-methods
183 //! [files]: fs::File
184 //! [multithreading]: thread
185 //! [other]: #what-is-in-the-standard-library-documentation
186 //! [primitive types]: ../book/ch03-02-data-types.html
187 //! [rust-discord]: https://discord.gg/rust-lang
188 //! [array]: prim@array
189 //! [slice]: prim@slice
190 #![cfg_attr(not(feature = "restricted-std"), stable(feature = "rust1", since = "1.0.0"))]
191 #![cfg_attr(feature = "restricted-std", unstable(feature = "restricted_std", issue = "none"))]
193 html_playground_url = "https://play.rust-lang.org/",
194 issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
195 test(no_crate_inject, attr(deny(warnings))),
196 test(attr(allow(dead_code, deprecated, unused_variables, unused_mut)))
200 not(any(test, bootstrap)),
201 no_global_oom_handling,
202 not(no_global_oom_handling)
204 // Don't link to std. We are std.
206 #![warn(deprecated_in_future)]
207 #![warn(missing_docs)]
208 #![warn(missing_debug_implementations)]
209 #![allow(explicit_outlives_requirements)]
210 #![allow(unused_lifetimes)]
211 // Tell the compiler to link to either panic_abort or panic_unwind
212 #![needs_panic_runtime]
213 // std may use features in a platform-specific way
214 #![allow(unused_features)]
215 #![cfg_attr(test, feature(internal_output_capture, print_internals, update_panic_count))]
217 all(target_vendor = "fortanix", target_env = "sgx"),
218 feature(slice_index_methods, coerce_unsized, sgx_platform)
220 #![deny(rustc::existing_doc_keyword)]
221 // std is implemented with unstable features, many of which are internal
222 // compiler details that will never be stable
223 // NB: the following list is sorted to minimize merge conflicts.
224 #![feature(alloc_error_handler)]
225 #![feature(alloc_layout_extra)]
226 #![feature(allocator_api)]
227 #![feature(allocator_internals)]
228 #![feature(allow_internal_unsafe)]
229 #![feature(allow_internal_unstable)]
230 #![feature(array_error_internals)]
231 #![feature(assert_matches)]
232 #![feature(associated_type_bounds)]
233 #![feature(async_iterator)]
234 #![feature(atomic_mut_ptr)]
235 #![feature(bench_black_box)]
236 #![feature(box_syntax)]
237 #![feature(c_unwind)]
238 #![feature(c_variadic)]
239 #![feature(cfg_accessible)]
240 #![feature(cfg_eval)]
241 #![feature(cfg_target_thread_local)]
242 #![feature(char_error_internals)]
243 #![feature(char_internals)]
244 #![feature(concat_bytes)]
245 #![feature(concat_idents)]
246 #![cfg_attr(bootstrap, feature(const_fn_fn_ptr_basics))]
247 #![cfg_attr(bootstrap, feature(const_fn_trait_bound))]
248 #![feature(const_format_args)]
249 #![feature(const_io_structs)]
250 #![feature(const_ip)]
251 #![feature(const_ipv4)]
252 #![feature(const_ipv6)]
253 #![feature(const_mut_refs)]
254 #![feature(const_option)]
255 #![feature(const_socketaddr)]
256 #![feature(const_trait_impl)]
257 #![feature(c_size_t)]
258 #![feature(core_ffi_c)]
259 #![feature(core_intrinsics)]
260 #![feature(core_panic)]
261 #![feature(custom_test_frameworks)]
262 #![feature(decl_macro)]
264 #![feature(doc_cfg_hide)]
265 #![feature(rustdoc_internals)]
266 #![feature(doc_masked)]
267 #![feature(doc_notable_trait)]
268 #![feature(dropck_eyepatch)]
269 #![feature(duration_checked_float)]
270 #![feature(duration_constants)]
271 #![feature(edition_panic)]
272 #![feature(exact_size_is_empty)]
273 #![feature(exhaustive_patterns)]
274 #![feature(extend_one)]
275 #![feature(float_minimum_maximum)]
276 #![feature(format_args_nl)]
277 #![feature(get_mut_unchecked)]
278 #![feature(hashmap_internals)]
279 #![feature(int_error_internals)]
280 #![feature(intra_doc_pointers)]
281 #![feature(lang_items)]
283 #![feature(log_syntax)]
284 #![feature(map_try_insert)]
285 #![feature(maybe_uninit_slice)]
286 #![feature(maybe_uninit_write_slice)]
287 #![feature(min_specialization)]
288 #![feature(mixed_integer_ops)]
289 #![feature(must_not_suspend)]
290 #![feature(needs_panic_runtime)]
291 #![feature(negative_impls)]
292 #![feature(never_type)]
293 #![feature(new_uninit)]
295 #![feature(nonnull_slice_from_raw_parts)]
296 #![feature(once_cell)]
297 #![feature(panic_info_message)]
298 #![feature(panic_internals)]
299 #![feature(panic_can_unwind)]
300 #![feature(panic_unwind)]
301 #![feature(platform_intrinsics)]
302 #![feature(portable_simd)]
303 #![feature(prelude_import)]
304 #![feature(ptr_as_uninit)]
305 #![feature(raw_os_nonzero)]
306 #![feature(rustc_attrs)]
307 #![feature(saturating_int_impl)]
308 #![feature(slice_internals)]
309 #![feature(slice_ptr_get)]
310 #![feature(staged_api)]
311 #![feature(std_internals)]
313 #![feature(str_internals)]
315 #![feature(thread_local)]
316 #![feature(thread_local_internals)]
317 #![feature(toowned_clone_into)]
318 #![feature(total_cmp)]
319 #![feature(trace_macros)]
320 #![feature(try_blocks)]
321 #![feature(try_reserve_kind)]
322 #![feature(vec_into_raw_parts)]
323 // NB: the above list is sorted to minimize merge conflicts.
324 #![default_lib_allocator]
326 // Explicitly import the prelude. The compiler uses this same unstable attribute
327 // to import the prelude implicitly when building crates that depend on std.
332 // Access to Bencher, etc.
336 #[allow(unused_imports)] // macros from `alloc` are not used on all platforms
338 extern crate alloc as alloc_crate;
340 #[allow(unused_extern_crates)]
343 // We always need an unwinder currently for backtraces
345 #[allow(unused_extern_crates)]
349 #[allow(unused_extern_crates)]
350 #[cfg(feature = "miniz_oxide")]
351 extern crate miniz_oxide;
353 // During testing, this crate is not actually the "real" std library, but rather
354 // it links to the real std library, which was compiled from this same source
355 // code. So any lang items std defines are conditionally excluded (or else they
356 // would generate duplicate lang item errors), and any globals it defines are
357 // _not_ the globals used by "real" std. So this import, defined only during
358 // testing gives test-std access to real-std lang items and globals. See #2912
360 extern crate std as realstd;
362 // The standard macros that are not built-in to the compiler.
369 // Public module declarations and re-exports
370 #[stable(feature = "rust1", since = "1.0.0")]
371 pub use alloc_crate::borrow;
372 #[stable(feature = "rust1", since = "1.0.0")]
373 pub use alloc_crate::boxed;
374 #[stable(feature = "rust1", since = "1.0.0")]
375 pub use alloc_crate::fmt;
376 #[stable(feature = "rust1", since = "1.0.0")]
377 pub use alloc_crate::format;
378 #[stable(feature = "rust1", since = "1.0.0")]
379 pub use alloc_crate::rc;
380 #[stable(feature = "rust1", since = "1.0.0")]
381 pub use alloc_crate::slice;
382 #[stable(feature = "rust1", since = "1.0.0")]
383 pub use alloc_crate::str;
384 #[stable(feature = "rust1", since = "1.0.0")]
385 pub use alloc_crate::string;
386 #[stable(feature = "rust1", since = "1.0.0")]
387 pub use alloc_crate::vec;
388 #[stable(feature = "rust1", since = "1.0.0")]
390 #[stable(feature = "core_array", since = "1.36.0")]
392 #[unstable(feature = "async_iterator", issue = "79024")]
393 pub use core::async_iter;
394 #[stable(feature = "rust1", since = "1.0.0")]
396 #[stable(feature = "rust1", since = "1.0.0")]
398 #[stable(feature = "rust1", since = "1.0.0")]
400 #[stable(feature = "rust1", since = "1.0.0")]
402 #[stable(feature = "rust1", since = "1.0.0")]
403 pub use core::convert;
404 #[stable(feature = "rust1", since = "1.0.0")]
405 pub use core::default;
406 #[stable(feature = "futures_api", since = "1.36.0")]
407 pub use core::future;
408 #[stable(feature = "rust1", since = "1.0.0")]
410 #[stable(feature = "core_hint", since = "1.27.0")]
412 #[stable(feature = "i128", since = "1.26.0")]
413 #[allow(deprecated, deprecated_in_future)]
415 #[stable(feature = "rust1", since = "1.0.0")]
416 #[allow(deprecated, deprecated_in_future)]
418 #[stable(feature = "rust1", since = "1.0.0")]
419 #[allow(deprecated, deprecated_in_future)]
421 #[stable(feature = "rust1", since = "1.0.0")]
422 #[allow(deprecated, deprecated_in_future)]
424 #[stable(feature = "rust1", since = "1.0.0")]
425 #[allow(deprecated, deprecated_in_future)]
427 #[stable(feature = "rust1", since = "1.0.0")]
428 pub use core::intrinsics;
429 #[stable(feature = "rust1", since = "1.0.0")]
430 #[allow(deprecated, deprecated_in_future)]
432 #[stable(feature = "rust1", since = "1.0.0")]
434 #[stable(feature = "rust1", since = "1.0.0")]
435 pub use core::marker;
436 #[stable(feature = "rust1", since = "1.0.0")]
438 #[stable(feature = "rust1", since = "1.0.0")]
440 #[stable(feature = "rust1", since = "1.0.0")]
441 pub use core::option;
442 #[stable(feature = "pin", since = "1.33.0")]
444 #[stable(feature = "rust1", since = "1.0.0")]
446 #[stable(feature = "rust1", since = "1.0.0")]
447 pub use core::result;
448 #[stable(feature = "i128", since = "1.26.0")]
449 #[allow(deprecated, deprecated_in_future)]
451 #[stable(feature = "rust1", since = "1.0.0")]
452 #[allow(deprecated, deprecated_in_future)]
454 #[stable(feature = "rust1", since = "1.0.0")]
455 #[allow(deprecated, deprecated_in_future)]
457 #[stable(feature = "rust1", since = "1.0.0")]
458 #[allow(deprecated, deprecated_in_future)]
460 #[stable(feature = "rust1", since = "1.0.0")]
461 #[allow(deprecated, deprecated_in_future)]
463 #[stable(feature = "rust1", since = "1.0.0")]
464 #[allow(deprecated, deprecated_in_future)]
489 #[unstable(feature = "once_cell", issue = "74465")]
492 // Pull in `std_float` crate into libstd. The contents of
493 // `std_float` are in a different repository: rust-lang/portable-simd.
494 #[path = "../../portable-simd/crates/std_float/src/lib.rs"]
495 #[allow(missing_debug_implementations, dead_code, unsafe_op_in_unsafe_fn, unused_unsafe)]
496 #[allow(rustdoc::bare_urls)]
497 #[unstable(feature = "portable_simd", issue = "86656")]
498 #[cfg(not(all(miri, doctest)))] // Miri does not support all SIMD intrinsics
501 #[cfg(not(all(miri, doctest)))] // Miri does not support all SIMD intrinsics
502 #[doc = include_str!("../../portable-simd/crates/core_simd/src/core_simd_docs.md")]
503 #[unstable(feature = "portable_simd", issue = "86656")]
506 pub use crate::std_float::StdFloat;
508 pub use core::simd::*;
511 #[stable(feature = "futures_api", since = "1.36.0")]
513 //! Types and Traits for working with asynchronous tasks.
516 #[stable(feature = "futures_api", since = "1.36.0")]
517 pub use core::task::*;
520 #[stable(feature = "wake_trait", since = "1.51.0")]
521 pub use alloc::task::*;
524 #[doc = include_str!("../../stdarch/crates/core_arch/src/core_arch_docs.md")]
525 #[stable(feature = "simd_arch", since = "1.27.0")]
527 #[stable(feature = "simd_arch", since = "1.27.0")]
528 // The `no_inline`-attribute is required to make the documentation of all
529 // targets available.
530 // See https://github.com/rust-lang/rust/pull/57808#issuecomment-457390549 for
532 #[doc(no_inline)] // Note (#82861): required for correct documentation
533 pub use core::arch::*;
535 #[stable(feature = "simd_aarch64", since = "1.60.0")]
536 pub use std_detect::is_aarch64_feature_detected;
537 #[stable(feature = "simd_x86", since = "1.27.0")]
538 pub use std_detect::is_x86_feature_detected;
539 #[unstable(feature = "stdsimd", issue = "48556")]
540 pub use std_detect::{
541 is_arm_feature_detected, is_mips64_feature_detected, is_mips_feature_detected,
542 is_powerpc64_feature_detected, is_powerpc_feature_detected, is_riscv_feature_detected,
546 // This was stabilized in the crate root so we have to keep it there.
547 #[stable(feature = "simd_x86", since = "1.27.0")]
548 pub use std_detect::is_x86_feature_detected;
550 // The runtime entry point and a few unstable public functions used by the
555 // Platform-abstraction modules
561 // Private support modules
564 #[path = "../../backtrace/src/lib.rs"]
565 #[allow(dead_code, unused_attributes)]
568 // Re-export macros defined in libcore.
569 #[stable(feature = "rust1", since = "1.0.0")]
570 #[allow(deprecated, deprecated_in_future)]
572 assert_eq, assert_ne, debug_assert, debug_assert_eq, debug_assert_ne, matches, r#try, todo,
573 unimplemented, unreachable, write, writeln,
576 // Re-export built-in macros defined through libcore.
577 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
580 assert, assert_matches, cfg, column, compile_error, concat, concat_idents, const_format_args,
581 env, file, format_args, format_args_nl, include, include_bytes, include_str, line, log_syntax,
582 module_path, option_env, stringify, trace_macros,
586 feature = "concat_bytes",
588 reason = "`concat_bytes` is not stable enough for use and is subject to change"
590 pub use core::concat_bytes;
592 #[stable(feature = "core_primitive", since = "1.43.0")]
593 pub use core::primitive;
595 // Include a number of private modules that exist solely to provide
596 // the rustdoc documentation for primitive types. Using `include!`
597 // because rustdoc only looks for these modules at the crate level.
598 include!("primitive_docs.rs");
600 // Include a number of private modules that exist solely to provide
601 // the rustdoc documentation for the existing keywords. Using `include!`
602 // because rustdoc only looks for these modules at the crate level.
603 include!("keyword_docs.rs");
605 // This is required to avoid an unstable error when `restricted-std` is not
606 // enabled. The use of #![feature(restricted_std)] in rustc-std-workspace-std
607 // is unconditional, so the unstable feature needs to be defined somewhere.
608 #[unstable(feature = "restricted_std", issue = "none")]
609 mod __restricted_std_workaround {}
612 /// This trait being unreachable from outside the crate
613 /// prevents outside implementations of our extension traits.
614 /// This allows adding more trait methods in the future.
615 #[unstable(feature = "sealed", issue = "none")]