]>
git.proxmox.com Git - rustc.git/blob - library/std/src/keyword_docs.rs
3 /// Cast between types, or rename an import.
5 /// `as` is most commonly used to turn primitive types into other primitive types, but it has other
6 /// uses that include turning pointers into addresses, addresses into pointers, and pointers into
10 /// let thing1: u8 = 89.0 as u8;
11 /// assert_eq!('B' as u32, 66);
12 /// assert_eq!(thing1 as char, 'Y');
13 /// let thing2: f32 = thing1 as f32 + 10.5;
14 /// assert_eq!(true as u8 + thing2 as u8, 100);
17 /// In general, any cast that can be performed via ascribing the type can also be done using `as`,
18 /// so instead of writing `let x: u32 = 123`, you can write `let x = 123 as u32` (note: `let x: u32
19 /// = 123` would be best in that situation). The same is not true in the other direction, however;
20 /// explicitly using `as` allows a few more coercions that aren't allowed implicitly, such as
21 /// changing the type of a raw pointer or turning closures into raw pointers.
23 /// `as` can be seen as the primitive for `From` and `Into`: `as` only works with primitives
24 /// (`u8`, `bool`, `str`, pointers, ...) whereas `From` and `Into` also works with types like
25 /// `String` or `Vec`.
27 /// `as` can also be used with the `_` placeholder when the destination type can be inferred. Note
28 /// that this can cause inference breakage and usually such code should use an explicit type for
29 /// both clarity and stability. This is most useful when converting pointers using `as *const _` or
30 /// `as *mut _` though the [`cast`][const-cast] method is recommended over `as *const _` and it is
31 /// [the same][mut-cast] for `as *mut _`: those methods make the intent clearer.
33 /// `as` is also used to rename imports in [`use`] and [`extern crate`][`crate`] statements:
36 /// # #[allow(unused_imports)]
37 /// use std::{mem as memory, net as network};
38 /// // Now you can use the names `memory` and `network` to refer to `std::mem` and `std::net`.
40 /// For more information on what `as` is capable of, see the [Reference].
42 /// [Reference]: ../reference/expressions/operator-expr.html#type-cast-expressions
43 /// [`crate`]: keyword.crate.html
44 /// [`use`]: keyword.use.html
45 /// [const-cast]: pointer::cast
46 /// [mut-cast]: primitive.pointer.html#method.cast-1
49 #[doc(keyword = "break")]
51 /// Exit early from a loop.
53 /// When `break` is encountered, execution of the associated loop body is
54 /// immediately terminated.
66 /// assert_eq!(last, 12);
67 /// println!("{}", last);
70 /// A break expression is normally associated with the innermost loop enclosing the
71 /// `break` but a label can be used to specify which enclosing loop is affected.
74 /// 'outer: for i in 1..=5 {
75 /// println!("outer iteration (i): {}", i);
77 /// '_inner: for j in 1..=200 {
78 /// println!(" inner iteration (j): {}", j);
80 /// // breaks from inner loop, let's outer loop continue.
84 /// // breaks from outer loop, and directly to "Bye".
92 /// When associated with `loop`, a break expression may be used to return a value from that loop.
93 /// This is only valid with `loop` and not with any other type of loop.
94 /// If no value is specified, `break;` returns `()`.
95 /// Every `break` within a loop must return the same type.
98 /// let (mut a, mut b) = (1, 1);
99 /// let result = loop {
107 /// // first number in Fibonacci sequence over 10:
108 /// assert_eq!(result, 13);
109 /// println!("{}", result);
112 /// For more details consult the [Reference on "break expression"] and the [Reference on "break and
115 /// [Reference on "break expression"]: ../reference/expressions/loop-expr.html#break-expressions
116 /// [Reference on "break and loop values"]:
117 /// ../reference/expressions/loop-expr.html#break-and-loop-values
120 #[doc(keyword = "const")]
122 /// Compile-time constants and compile-time evaluable functions.
124 /// ## Compile-time constants
126 /// Sometimes a certain value is used many times throughout a program, and it can become
127 /// inconvenient to copy it over and over. What's more, it's not always possible or desirable to
128 /// make it a variable that gets carried around to each function that needs it. In these cases, the
129 /// `const` keyword provides a convenient alternative to code duplication:
132 /// const THING: u32 = 0xABAD1DEA;
134 /// let foo = 123 + THING;
137 /// Constants must be explicitly typed; unlike with `let`, you can't ignore their type and let the
138 /// compiler figure it out. Any constant value can be defined in a `const`, which in practice happens
139 /// to be most things that would be reasonable to have in a constant (barring `const fn`s). For
140 /// example, you can't have a [`File`] as a `const`.
142 /// [`File`]: crate::fs::File
144 /// The only lifetime allowed in a constant is `'static`, which is the lifetime that encompasses
145 /// all others in a Rust program. For example, if you wanted to define a constant string, it would
149 /// const WORDS: &'static str = "hello rust!";
152 /// Thanks to static lifetime elision, you usually don't have to explicitly use `'static`:
155 /// const WORDS: &str = "hello convenience!";
158 /// `const` items looks remarkably similar to `static` items, which introduces some confusion as
159 /// to which one should be used at which times. To put it simply, constants are inlined wherever
160 /// they're used, making using them identical to simply replacing the name of the `const` with its
161 /// value. Static variables, on the other hand, point to a single location in memory, which all
162 /// accesses share. This means that, unlike with constants, they can't have destructors, and act as
163 /// a single value across the entire codebase.
165 /// Constants, like statics, should always be in `SCREAMING_SNAKE_CASE`.
167 /// For more detail on `const`, see the [Rust Book] or the [Reference].
169 /// ## Compile-time evaluable functions
171 /// The other main use of the `const` keyword is in `const fn`. This marks a function as being
172 /// callable in the body of a `const` or `static` item and in array initializers (commonly called
173 /// "const contexts"). `const fn` are restricted in the set of operations they can perform, to
174 /// ensure that they can be evaluated at compile-time. See the [Reference][const-eval] for more
177 /// Turning a `fn` into a `const fn` has no effect on run-time uses of that function.
179 /// ## Other uses of `const`
181 /// The `const` keyword is also used in raw pointers in combination with `mut`, as seen in `*const
182 /// T` and `*mut T`. More about `const` as used in raw pointers can be read at the Rust docs for the [pointer primitive].
184 /// [pointer primitive]: pointer
185 /// [Rust Book]: ../book/ch03-01-variables-and-mutability.html#differences-between-variables-and-constants
186 /// [Reference]: ../reference/items/constant-items.html
187 /// [const-eval]: ../reference/const_eval.html
190 #[doc(keyword = "continue")]
192 /// Skip to the next iteration of a loop.
194 /// When `continue` is encountered, the current iteration is terminated, returning control to the
195 /// loop head, typically continuing with the next iteration.
198 /// // Printing odd numbers by skipping even ones
199 /// for number in 1..=10 {
200 /// if number % 2 == 0 {
203 /// println!("{}", number);
207 /// Like `break`, `continue` is normally associated with the innermost enclosing loop, but labels
208 /// may be used to specify the affected loop.
211 /// // Print Odd numbers under 30 with unit <= 5
212 /// 'tens: for ten in 0..3 {
213 /// '_units: for unit in 0..=9 {
214 /// if unit % 2 == 0 {
220 /// println!("{}", ten * 10 + unit);
225 /// See [continue expressions] from the reference for more details.
227 /// [continue expressions]: ../reference/expressions/loop-expr.html#continue-expressions
228 mod continue_keyword {}
230 #[doc(keyword = "crate")]
232 /// A Rust binary or library.
234 /// The primary use of the `crate` keyword is as a part of `extern crate` declarations, which are
235 /// used to specify a dependency on a crate external to the one it's declared in. Crates are the
236 /// fundamental compilation unit of Rust code, and can be seen as libraries or projects. More can
237 /// be read about crates in the [Reference].
240 /// extern crate rand;
241 /// extern crate my_crate as thing;
242 /// extern crate std; // implicitly added to the root of every Rust project
245 /// The `as` keyword can be used to change what the crate is referred to as in your project. If a
246 /// crate name includes a dash, it is implicitly imported with the dashes replaced by underscores.
248 /// `crate` can also be used as in conjunction with `pub` to signify that the item it's attached to
249 /// is public only to other members of the same crate it's in.
252 /// # #[allow(unused_imports)]
253 /// pub(crate) use std::io::Error as IoError;
254 /// pub(crate) enum CoolMarkerType { }
255 /// pub struct PublicThing {
256 /// pub(crate) semi_secret_thing: bool,
260 /// `crate` is also used to represent the absolute path of a module, where `crate` refers to the
261 /// root of the current crate. For instance, `crate::foo::bar` refers to the name `bar` inside the
262 /// module `foo`, from anywhere else in the same crate.
264 /// [Reference]: ../reference/items/extern-crates.html
267 #[doc(keyword = "else")]
269 /// What expression to evaluate when an [`if`] condition evaluates to [`false`].
271 /// `else` expressions are optional. When no else expressions are supplied it is assumed to evaluate
272 /// to the unit type `()`.
274 /// The type that the `else` blocks evaluate to must be compatible with the type that the `if` block
277 /// As can be seen below, `else` must be followed by either: `if`, `if let`, or a block `{}` and it
278 /// will return the value of that expression.
281 /// let result = if true == false {
283 /// } else if "something" == "other thing" {
285 /// } else if let Some(200) = "blarg".parse::<i32>().ok() {
288 /// println!("Sneaky side effect.");
289 /// "phew, nothing's broken"
293 /// Here's another example but here we do not try and return an expression:
296 /// if true == false {
297 /// println!("oh no");
298 /// } else if "something" == "other thing" {
299 /// println!("oh dear");
300 /// } else if let Some(200) = "blarg".parse::<i32>().ok() {
301 /// println!("uh oh");
303 /// println!("phew, nothing's broken");
307 /// The above is _still_ an expression but it will always evaluate to `()`.
309 /// There is possibly no limit to the number of `else` blocks that could follow an `if` expression
310 /// however if you have several then a [`match`] expression might be preferable.
312 /// Read more about control flow in the [Rust Book].
314 /// [Rust Book]: ../book/ch03-05-control-flow.html#handling-multiple-conditions-with-else-if
315 /// [`match`]: keyword.match.html
316 /// [`false`]: keyword.false.html
317 /// [`if`]: keyword.if.html
320 #[doc(keyword = "enum")]
322 /// A type that can be any one of several variants.
324 /// Enums in Rust are similar to those of other compiled languages like C, but have important
325 /// differences that make them considerably more powerful. What Rust calls enums are more commonly
326 /// known as [Algebraic Data Types][ADT] if you're coming from a functional programming background.
327 /// The important detail is that each enum variant can have data to go along with it.
331 /// enum SimpleEnum {
343 /// enum ComplexEnum {
347 /// usual_struct_stuff: bool,
352 /// enum EmptyEnum { }
355 /// The first enum shown is the usual kind of enum you'd find in a C-style language. The second
356 /// shows off a hypothetical example of something storing location data, with `Coord` being any
357 /// other type that's needed, for example a struct. The third example demonstrates the kind of
358 /// data a variant can store, ranging from nothing, to a tuple, to an anonymous struct.
360 /// Instantiating enum variants involves explicitly using the enum's name as its namespace,
361 /// followed by one of its variants. `SimpleEnum::SecondVariant` would be an example from above.
362 /// When data follows along with a variant, such as with rust's built-in [`Option`] type, the data
363 /// is added as the type describes, for example `Option::Some(123)`. The same follows with
364 /// struct-like variants, with things looking like `ComplexEnum::LotsOfThings { usual_struct_stuff:
365 /// true, blah: "hello!".to_string(), }`. Empty Enums are similar to [`!`] in that they cannot be
366 /// instantiated at all, and are used mainly to mess with the type system in interesting ways.
368 /// For more information, take a look at the [Rust Book] or the [Reference]
370 /// [ADT]: https://en.wikipedia.org/wiki/Algebraic_data_type
371 /// [Rust Book]: ../book/ch06-01-defining-an-enum.html
372 /// [Reference]: ../reference/items/enumerations.html
375 #[doc(keyword = "extern")]
377 /// Link to or import external code.
379 /// The `extern` keyword is used in two places in Rust. One is in conjunction with the [`crate`]
380 /// keyword to make your Rust code aware of other Rust crates in your project, i.e., `extern crate
381 /// lazy_static;`. The other use is in foreign function interfaces (FFI).
383 /// `extern` is used in two different contexts within FFI. The first is in the form of external
384 /// blocks, for declaring function interfaces that Rust code can call foreign code by.
387 /// #[link(name = "my_c_library")]
389 /// fn my_c_function(x: i32) -> bool;
393 /// This code would attempt to link with `libmy_c_library.so` on unix-like systems and
394 /// `my_c_library.dll` on Windows at runtime, and panic if it can't find something to link to. Rust
395 /// code could then use `my_c_function` as if it were any other unsafe Rust function. Working with
396 /// non-Rust languages and FFI is inherently unsafe, so wrappers are usually built around C APIs.
398 /// The mirror use case of FFI is also done via the `extern` keyword:
402 /// pub extern "C" fn callable_from_c(x: i32) -> bool {
407 /// If compiled as a dylib, the resulting .so could then be linked to from a C library, and the
408 /// function could be used as if it was from any other library.
410 /// For more information on FFI, check the [Rust book] or the [Reference].
413 /// ../book/ch19-01-unsafe-rust.html#using-extern-functions-to-call-external-code
414 /// [Reference]: ../reference/items/external-blocks.html
415 /// [`crate`]: keyword.crate.html
416 mod extern_keyword {}
418 #[doc(keyword = "false")]
420 /// A value of type [`bool`] representing logical **false**.
422 /// `false` is the logical opposite of [`true`].
424 /// See the documentation for [`true`] for more information.
426 /// [`true`]: keyword.true.html
429 #[doc(keyword = "fn")]
431 /// A function or function pointer.
433 /// Functions are the primary way code is executed within Rust. Function blocks, usually just
434 /// called functions, can be defined in a variety of different places and be assigned many
435 /// different attributes and modifiers.
437 /// Standalone functions that just sit within a module not attached to anything else are common,
438 /// but most functions will end up being inside [`impl`] blocks, either on another type itself, or
439 /// as a trait impl for that type.
442 /// fn standalone_function() {
446 /// pub fn public_thing(argument: bool) -> String {
456 /// pub fn new() -> Self {
464 /// In addition to presenting fixed types in the form of `fn name(arg: type, ..) -> return_type`,
465 /// functions can also declare a list of type parameters along with trait bounds that they fall
469 /// fn generic_function<T: Clone>(x: T) -> (T, T, T) {
470 /// (x.clone(), x.clone(), x.clone())
473 /// fn generic_where<T>(x: T) -> T
474 /// where T: std::ops::Add<Output = T> + Copy
480 /// Declaring trait bounds in the angle brackets is functionally identical to using a `where`
481 /// clause. It's up to the programmer to decide which works better in each situation, but `where`
482 /// tends to be better when things get longer than one line.
484 /// Along with being made public via `pub`, `fn` can also have an [`extern`] added for use in
487 /// For more information on the various types of functions and how they're used, consult the [Rust
488 /// book] or the [Reference].
490 /// [`impl`]: keyword.impl.html
491 /// [`extern`]: keyword.extern.html
492 /// [Rust book]: ../book/ch03-03-how-functions-work.html
493 /// [Reference]: ../reference/items/functions.html
496 #[doc(keyword = "for")]
498 /// Iteration with [`in`], trait implementation with [`impl`], or [higher-ranked trait bounds]
501 /// The `for` keyword is used in many syntactic locations:
503 /// * `for` is used in for-in-loops (see below).
504 /// * `for` is used when implementing traits as in `impl Trait for Type` (see [`impl`] for more info
506 /// * `for` is also used for [higher-ranked trait bounds] as in `for<'a> &'a T: PartialEq<i32>`.
508 /// for-in-loops, or to be more precise, iterator loops, are a simple syntactic sugar over a common
509 /// practice within Rust, which is to loop over anything that implements [`IntoIterator`] until the
510 /// iterator returned by `.into_iter()` returns `None` (or the loop body uses `break`).
514 /// println!("{}", i * 2);
517 /// for i in std::iter::repeat(5) {
518 /// println!("turns out {} never stops being 5", i);
519 /// break; // would loop forever otherwise
522 /// 'outer: for x in 5..50 {
531 /// As shown in the example above, `for` loops (along with all other loops) can be tagged, using
532 /// similar syntax to lifetimes (only visually similar, entirely distinct in practice). Giving the
533 /// same tag to `break` breaks the tagged loop, which is useful for inner loops. It is definitely
536 /// A `for` loop expands as shown:
540 /// # let iterator = 0..2;
541 /// for loop_variable in iterator {
548 /// # let iterator = 0..2;
550 /// let result = match IntoIterator::into_iter(iterator) {
551 /// mut iter => loop {
553 /// match iter.next() {
554 /// Some(val) => next = val,
557 /// let loop_variable = next;
558 /// let () = { code(); };
565 /// More details on the functionality shown can be seen at the [`IntoIterator`] docs.
567 /// For more information on for-loops, see the [Rust book] or the [Reference].
569 /// See also, [`loop`], [`while`].
571 /// [`in`]: keyword.in.html
572 /// [`impl`]: keyword.impl.html
573 /// [`loop`]: keyword.loop.html
574 /// [`while`]: keyword.while.html
575 /// [higher-ranked trait bounds]: ../reference/trait-bounds.html#higher-ranked-trait-bounds
577 /// ../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
578 /// [Reference]: ../reference/expressions/loop-expr.html#iterator-loops
581 #[doc(keyword = "if")]
583 /// Evaluate a block if a condition holds.
585 /// `if` is a familiar construct to most programmers, and is the main way you'll often do logic in
586 /// your code. However, unlike in most languages, `if` blocks can also act as expressions.
589 /// # let rude = true;
591 /// println!("whoops, mathematics broke");
593 /// println!("everything's fine!");
596 /// let greeting = if rude {
602 /// if let Ok(x) = "123".parse::<i32>() {
603 /// println!("{} double that and you get {}!", greeting, x * 2);
607 /// Shown above are the three typical forms an `if` block comes in. First is the usual kind of
608 /// thing you'd see in many languages, with an optional `else` block. Second uses `if` as an
609 /// expression, which is only possible if all branches return the same type. An `if` expression can
610 /// be used everywhere you'd expect. The third kind of `if` block is an `if let` block, which
611 /// behaves similarly to using a `match` expression:
614 /// if let Some(x) = Some(123) {
618 /// // something else
621 /// match Some(123) {
627 /// // something else
632 /// Each kind of `if` expression can be mixed and matched as needed.
635 /// if true == false {
636 /// println!("oh no");
637 /// } else if "something" == "other thing" {
638 /// println!("oh dear");
639 /// } else if let Some(200) = "blarg".parse::<i32>().ok() {
640 /// println!("uh oh");
642 /// println!("phew, nothing's broken");
646 /// The `if` keyword is used in one other place in Rust, namely as a part of pattern matching
647 /// itself, allowing patterns such as `Some(x) if x > 200` to be used.
649 /// For more information on `if` expressions, see the [Rust book] or the [Reference].
651 /// [Rust book]: ../book/ch03-05-control-flow.html#if-expressions
652 /// [Reference]: ../reference/expressions/if-expr.html
655 #[doc(keyword = "impl")]
657 /// Implement some functionality for a type.
659 /// The `impl` keyword is primarily used to define implementations on types. Inherent
660 /// implementations are standalone, while trait implementations are used to implement traits for
661 /// types, or other traits.
663 /// Functions and consts can both be defined in an implementation. A function defined in an
664 /// `impl` block can be standalone, meaning it would be called like `Foo::bar()`. If the function
665 /// takes `self`, `&self`, or `&mut self` as its first argument, it can also be called using
666 /// method-call syntax, a familiar feature to any object oriented programmer, like `foo.bar()`.
675 /// println!("boo! Example::boo() was called!");
678 /// fn answer(&mut self) {
679 /// self.number += 42;
682 /// fn get_number(&self) -> i32 {
688 /// fn do_thingy(&self);
691 /// impl Thingy for Example {
692 /// fn do_thingy(&self) {
693 /// println!("doing a thing! also, number is {}!", self.number);
698 /// For more information on implementations, see the [Rust book][book1] or the [Reference].
700 /// The other use of the `impl` keyword is in `impl Trait` syntax, which can be seen as a shorthand
701 /// for "a concrete type that implements this trait". Its primary use is working with closures,
702 /// which have type definitions generated at compile time that can't be simply typed out.
705 /// fn thing_returning_closure() -> impl Fn(i32) -> bool {
706 /// println!("here's a closure for you!");
707 /// |x: i32| x % 3 == 0
711 /// For more information on `impl Trait` syntax, see the [Rust book][book2].
713 /// [book1]: ../book/ch05-03-method-syntax.html
714 /// [Reference]: ../reference/items/implementations.html
715 /// [book2]: ../book/ch10-02-traits.html#returning-types-that-implement-traits
718 #[doc(keyword = "in")]
720 /// Iterate over a series of values with [`for`].
722 /// The expression immediately following `in` must implement the [`IntoIterator`] trait.
724 /// ## Literal Examples:
726 /// * `for _ in 1..3 {}` - Iterate over an exclusive range up to but excluding 3.
727 /// * `for _ in 1..=3 {}` - Iterate over an inclusive range up to and including 3.
729 /// (Read more about [range patterns])
731 /// [`IntoIterator`]: ../book/ch13-04-performance.html
732 /// [range patterns]: ../reference/patterns.html?highlight=range#range-patterns
733 /// [`for`]: keyword.for.html
736 #[doc(keyword = "let")]
738 /// Bind a value to a variable.
740 /// The primary use for the `let` keyword is in `let` statements, which are used to introduce a new
741 /// set of variables into the current scope, as given by a pattern.
744 /// # #![allow(unused_assignments)]
745 /// let thing1: i32 = 100;
746 /// let thing2 = 200 + thing1;
748 /// let mut changing_thing = true;
749 /// changing_thing = false;
751 /// let (part1, part2) = ("first", "second");
758 /// let Example { a, b: _ } = Example {
765 /// The pattern is most commonly a single variable, which means no pattern matching is done and
766 /// the expression given is bound to the variable. Apart from that, patterns used in `let` bindings
767 /// can be as complicated as needed, given that the pattern is exhaustive. See the [Rust
768 /// book][book1] for more information on pattern matching. The type of the pattern is optionally
769 /// given afterwards, but if left blank is automatically inferred by the compiler if possible.
771 /// Variables in Rust are immutable by default, and require the `mut` keyword to be made mutable.
773 /// Multiple variables can be defined with the same name, known as shadowing. This doesn't affect
774 /// the original variable in any way beyond being unable to directly access it beyond the point of
775 /// shadowing. It continues to remain in scope, getting dropped only when it falls out of scope.
776 /// Shadowed variables don't need to have the same type as the variables shadowing them.
779 /// let shadowing_example = true;
780 /// let shadowing_example = 123.4;
781 /// let shadowing_example = shadowing_example as u32;
782 /// let mut shadowing_example = format!("cool! {}", shadowing_example);
783 /// shadowing_example += " something else!"; // not shadowing
786 /// Other places the `let` keyword is used include along with [`if`], in the form of `if let`
787 /// expressions. They're useful if the pattern being matched isn't exhaustive, such as with
788 /// enumerations. `while let` also exists, which runs a loop with a pattern matched value until
789 /// that pattern can't be matched.
791 /// For more information on the `let` keyword, see the [Rust book][book2] or the [Reference]
793 /// [book1]: ../book/ch06-02-match.html
794 /// [`if`]: keyword.if.html
795 /// [book2]: ../book/ch18-01-all-the-places-for-patterns.html#let-statements
796 /// [Reference]: ../reference/statements.html#let-statements
799 #[doc(keyword = "while")]
801 /// Loop while a condition is upheld.
803 /// A `while` expression is used for predicate loops. The `while` expression runs the conditional
804 /// expression before running the loop body, then runs the loop body if the conditional
805 /// expression evaluates to `true`, or exits the loop otherwise.
808 /// let mut counter = 0;
810 /// while counter < 10 {
811 /// println!("{}", counter);
816 /// Like the [`for`] expression, we can use `break` and `continue`. A `while` expression
817 /// cannot break with a value and always evaluates to `()` unlike [`loop`].
825 /// break; // Exit when `i` is 64.
830 /// As `if` expressions have their pattern matching variant in `if let`, so too do `while`
831 /// expressions with `while let`. The `while let` expression matches the pattern against the
832 /// expression, then runs the loop body if pattern matching succeeds, or exits the loop otherwise.
833 /// We can use `break` and `continue` in `while let` expressions just like in `while`.
836 /// let mut counter = Some(0);
838 /// while let Some(i) = counter {
842 /// println!("{}", i);
843 /// counter = Some (i + 1);
848 /// For more information on `while` and loops in general, see the [reference].
850 /// See also, [`for`], [`loop`].
852 /// [`for`]: keyword.for.html
853 /// [`loop`]: keyword.loop.html
854 /// [reference]: ../reference/expressions/loop-expr.html#predicate-loops
857 #[doc(keyword = "loop")]
859 /// Loop indefinitely.
861 /// `loop` is used to define the simplest kind of loop supported in Rust. It runs the code inside
862 /// it until the code uses `break` or the program exits.
866 /// println!("hello world forever!");
872 /// println!("i is {}", i);
878 /// assert_eq!(i, 128);
881 /// Unlike the other kinds of loops in Rust (`while`, `while let`, and `for`), loops can be used as
882 /// expressions that return values via `break`.
886 /// let something = loop {
892 /// assert_eq!(something, 128);
895 /// Every `break` in a loop has to have the same type. When it's not explicitly giving something,
896 /// `break;` returns `()`.
898 /// For more information on `loop` and loops in general, see the [Reference].
900 /// See also, [`for`], [`while`].
902 /// [`for`]: keyword.for.html
903 /// [`while`]: keyword.while.html
904 /// [Reference]: ../reference/expressions/loop-expr.html
907 #[doc(keyword = "match")]
909 /// Control flow based on pattern matching.
911 /// `match` can be used to run code conditionally. Every pattern must
912 /// be handled exhaustively either explicitly or by using wildcards like
913 /// `_` in the `match`. Since `match` is an expression, values can also be
917 /// let opt = Option::None::<usize>;
918 /// let x = match opt {
919 /// Some(int) => int,
922 /// assert_eq!(x, 10);
924 /// let a_number = Option::Some(10);
926 /// Some(x) if x <= 5 => println!("0 to 5 num = {}", x),
927 /// Some(x @ 6..=10) => println!("6 to 10 num = {}", x),
928 /// None => panic!(),
929 /// // all other numbers
934 /// `match` can be used to gain access to the inner members of an enum
935 /// and use them directly.
939 /// Double(Option<u8>, Option<String>),
940 /// Single(Option<u8>),
944 /// let get_inner = Outer::Double(None, Some(String::new()));
945 /// match get_inner {
946 /// Outer::Double(None, Some(st)) => println!("{}", st),
947 /// Outer::Single(opt) => println!("{:?}", opt),
952 /// For more information on `match` and matching in general, see the [Reference].
954 /// [Reference]: ../reference/expressions/match-expr.html
957 #[doc(keyword = "mod")]
959 /// Organize code into [modules].
961 /// Use `mod` to create new [modules] to encapsulate code, including other
967 /// type MyType = (u8, u8);
973 /// Like [`struct`]s and [`enum`]s, a module and its content are private by
974 /// default, unaccessible to code outside of the module.
976 /// To learn more about allowing access, see the documentation for the [`pub`]
979 /// [`enum`]: keyword.enum.html
980 /// [`pub`]: keyword.pub.html
981 /// [`struct`]: keyword.struct.html
982 /// [modules]: ../reference/items/modules.html
985 #[doc(keyword = "move")]
987 /// Capture a [closure]'s environment by value.
989 /// `move` converts any variables captured by reference or mutable reference
990 /// to variables captured by value.
993 /// let data = vec![1, 2, 3];
994 /// let closure = move || println!("captured {:?} by value", data);
996 /// // data is no longer available, it is owned by the closure
999 /// Note: `move` closures may still implement [`Fn`] or [`FnMut`], even though
1000 /// they capture variables by `move`. This is because the traits implemented by
1001 /// a closure type are determined by *what* the closure does with captured
1002 /// values, not *how* it captures them:
1005 /// fn create_fn() -> impl Fn() {
1006 /// let text = "Fn".to_owned();
1007 /// move || println!("This is a: {}", text)
1010 /// let fn_plain = create_fn();
1014 /// `move` is often used when [threads] are involved.
1017 /// let data = vec![1, 2, 3];
1019 /// std::thread::spawn(move || {
1020 /// println!("captured {:?} by value", data)
1021 /// }).join().unwrap();
1023 /// // data was moved to the spawned thread, so we cannot use it here
1026 /// `move` is also valid before an async block.
1029 /// let capture = "hello".to_owned();
1030 /// let block = async move {
1031 /// println!("rust says {} from async block", capture);
1035 /// For more information on the `move` keyword, see the [closures][closure] section
1036 /// of the Rust book or the [threads] section.
1038 /// [closure]: ../book/ch13-01-closures.html
1039 /// [threads]: ../book/ch16-01-threads.html#using-move-closures-with-threads
1042 #[doc(keyword = "mut")]
1044 /// A mutable variable, reference, or pointer.
1046 /// `mut` can be used in several situations. The first is mutable variables,
1047 /// which can be used anywhere you can bind a value to a variable name. Some
1051 /// // A mutable variable in the parameter list of a function.
1052 /// fn foo(mut x: u8, y: u8) -> u8 {
1057 /// // Modifying a mutable variable.
1058 /// # #[allow(unused_assignments)]
1062 /// assert_eq!(foo(3, 4), 7);
1063 /// assert_eq!(a, 6);
1066 /// The second is mutable references. They can be created from `mut` variables
1067 /// and must be unique: no other variables can have a mutable reference, nor a
1068 /// shared reference.
1071 /// // Taking a mutable reference.
1072 /// fn push_two(v: &mut Vec<u8>) {
1076 /// // A mutable reference cannot be taken to a non-mutable variable.
1077 /// let mut v = vec![0, 1];
1078 /// // Passing a mutable reference.
1079 /// push_two(&mut v);
1081 /// assert_eq!(v, vec![0, 1, 2]);
1084 /// ```rust,compile_fail,E0502
1085 /// let mut v = vec![0, 1];
1086 /// let mut_ref_v = &mut v;
1087 /// ##[allow(unused)]
1089 /// mut_ref_v.push(2);
1092 /// Mutable raw pointers work much like mutable references, with the added
1093 /// possibility of not pointing to a valid object. The syntax is `*mut Type`.
1095 /// More information on mutable references and pointers can be found in```
1098 /// [Reference]: ../reference/types/pointer.html#mutable-references-mut
1101 #[doc(keyword = "pub")]
1103 /// Make an item visible to others.
1105 /// The keyword `pub` makes any module, function, or data structure accessible from inside
1106 /// of external modules. The `pub` keyword may also be used in a `use` declaration to re-export
1107 /// an identifier from a namespace.
1109 /// For more information on the `pub` keyword, please see the visibility section
1110 /// of the [reference] and for some examples, see [Rust by Example].
1112 /// [reference]:../reference/visibility-and-privacy.html?highlight=pub#visibility-and-privacy
1113 /// [Rust by Example]:../rust-by-example/mod/visibility.html
1116 #[doc(keyword = "ref")]
1118 /// Bind by reference during pattern matching.
1120 /// `ref` annotates pattern bindings to make them borrow rather than move.
1121 /// It is **not** a part of the pattern as far as matching is concerned: it does
1122 /// not affect *whether* a value is matched, only *how* it is matched.
1124 /// By default, [`match`] statements consume all they can, which can sometimes
1125 /// be a problem, when you don't really need the value to be moved and owned:
1127 /// ```compile_fail,E0382
1128 /// let maybe_name = Some(String::from("Alice"));
1129 /// // The variable 'maybe_name' is consumed here ...
1130 /// match maybe_name {
1131 /// Some(n) => println!("Hello, {}", n),
1132 /// _ => println!("Hello, world"),
1134 /// // ... and is now unavailable.
1135 /// println!("Hello again, {}", maybe_name.unwrap_or("world".into()));
1138 /// Using the `ref` keyword, the value is only borrowed, not moved, making it
1139 /// available for use after the [`match`] statement:
1142 /// let maybe_name = Some(String::from("Alice"));
1143 /// // Using `ref`, the value is borrowed, not moved ...
1144 /// match maybe_name {
1145 /// Some(ref n) => println!("Hello, {}", n),
1146 /// _ => println!("Hello, world"),
1148 /// // ... so it's available here!
1149 /// println!("Hello again, {}", maybe_name.unwrap_or("world".into()));
1154 /// - `&` denotes that your pattern expects a reference to an object. Hence `&`
1155 /// is a part of said pattern: `&Foo` matches different objects than `Foo` does.
1157 /// - `ref` indicates that you want a reference to an unpacked value. It is not
1158 /// matched against: `Foo(ref foo)` matches the same objects as `Foo(foo)`.
1160 /// See also the [Reference] for more information.
1162 /// [`match`]: keyword.match.html
1163 /// [Reference]: ../reference/patterns.html#identifier-patterns
1166 #[doc(keyword = "return")]
1168 /// Return a value from a function.
1170 /// A `return` marks the end of an execution path in a function:
1173 /// fn foo() -> i32 {
1176 /// assert_eq!(foo(), 3);
1179 /// `return` is not needed when the returned value is the last expression in the
1180 /// function. In this case the `;` is omitted:
1183 /// fn foo() -> i32 {
1186 /// assert_eq!(foo(), 3);
1189 /// `return` returns from the function immediately (an "early return"):
1192 /// use std::fs::File;
1193 /// use std::io::{Error, ErrorKind, Read, Result};
1195 /// fn main() -> Result<()> {
1196 /// let mut file = match File::open("foo.txt") {
1198 /// Err(e) => return Err(e),
1201 /// let mut contents = String::new();
1202 /// let size = match file.read_to_string(&mut contents) {
1204 /// Err(e) => return Err(e),
1207 /// if contents.contains("impossible!") {
1208 /// return Err(Error::new(ErrorKind::Other, "oh no!"));
1211 /// if size > 9000 {
1212 /// return Err(Error::new(ErrorKind::Other, "over 9000!"));
1215 /// assert_eq!(contents, "Hello, world!");
1219 mod return_keyword {}
1221 #[doc(keyword = "self")]
1223 /// The receiver of a method, or the current module.
1225 /// `self` is used in two situations: referencing the current module and marking
1226 /// the receiver of a method.
1228 /// In paths, `self` can be used to refer to the current module, either in a
1229 /// [`use`] statement or in a path to access an element:
1232 /// # #![allow(unused_imports)]
1233 /// use std::io::{self, Read};
1236 /// Is functionally the same as:
1239 /// # #![allow(unused_imports)]
1241 /// use std::io::Read;
1244 /// Using `self` to access an element in the current module:
1247 /// # #![allow(dead_code)]
1255 /// `self` as the current receiver for a method allows to omit the parameter
1256 /// type most of the time. With the exception of this particularity, `self` is
1257 /// used much like any other parameter:
1260 /// struct Foo(i32);
1264 /// fn new() -> Self {
1268 /// // Consuming `self`.
1269 /// fn consume(self) -> Self {
1270 /// Self(self.0 + 1)
1273 /// // Borrowing `self`.
1274 /// fn borrow(&self) -> &i32 {
1278 /// // Borrowing `self` mutably.
1279 /// fn borrow_mut(&mut self) -> &mut i32 {
1284 /// // This method must be called with a `Type::` prefix.
1285 /// let foo = Foo::new();
1286 /// assert_eq!(foo.0, 0);
1288 /// // Those two calls produces the same result.
1289 /// let foo = Foo::consume(foo);
1290 /// assert_eq!(foo.0, 1);
1291 /// let foo = foo.consume();
1292 /// assert_eq!(foo.0, 2);
1294 /// // Borrowing is handled automatically with the second syntax.
1295 /// let borrow_1 = Foo::borrow(&foo);
1296 /// let borrow_2 = foo.borrow();
1297 /// assert_eq!(borrow_1, borrow_2);
1299 /// // Borrowing mutably is handled automatically too with the second syntax.
1300 /// let mut foo = Foo::new();
1301 /// *Foo::borrow_mut(&mut foo) += 1;
1302 /// assert_eq!(foo.0, 1);
1303 /// *foo.borrow_mut() += 1;
1304 /// assert_eq!(foo.0, 2);
1307 /// Note that this automatic conversion when calling `foo.method()` is not
1308 /// limited to the examples above. See the [Reference] for more information.
1310 /// [`use`]: keyword.use.html
1311 /// [Reference]: ../reference/items/associated-items.html#methods
1314 // FIXME: Once rustdoc can handle URL conflicts on case insensitive file systems, we can remove the
1315 // three next lines and put back: `#[doc(keyword = "Self")]`.
1316 #[doc(alias = "Self")]
1317 #[allow(rustc::existing_doc_keyword)]
1318 #[doc(keyword = "SelfTy")]
1320 /// The implementing type within a [`trait`] or [`impl`] block, or the current type within a type
1323 /// Within a type definition:
1326 /// # #![allow(dead_code)]
1329 /// // `Self` is a `Node` here.
1330 /// next: Option<Box<Self>>,
1334 /// In an [`impl`] block:
1337 /// struct Foo(i32);
1340 /// fn new() -> Self {
1345 /// assert_eq!(Foo::new().0, Foo(0).0);
1348 /// Generic parameters are implicit with `Self`:
1351 /// # #![allow(dead_code)]
1352 /// struct Wrap<T> {
1356 /// impl<T> Wrap<T> {
1357 /// fn new(elem: T) -> Self {
1363 /// In a [`trait`] definition and related [`impl`] block:
1367 /// fn example() -> Self;
1370 /// struct Foo(i32);
1372 /// impl Example for Foo {
1373 /// fn example() -> Self {
1378 /// assert_eq!(Foo::example().0, Foo(42).0);
1381 /// [`impl`]: keyword.impl.html
1382 /// [`trait`]: keyword.trait.html
1383 mod self_upper_keyword {}
1385 #[doc(keyword = "static")]
1387 /// A static item is a value which is valid for the entire duration of your
1388 /// program (a `'static` lifetime).
1390 /// On the surface, `static` items seem very similar to [`const`]s: both contain
1391 /// a value, both require type annotations and both can only be initialized with
1392 /// constant functions and values. However, `static`s are notably different in
1393 /// that they represent a location in memory. That means that you can have
1394 /// references to `static` items and potentially even modify them, making them
1395 /// essentially global variables.
1397 /// Static items do not call [`drop`] at the end of the program.
1399 /// There are two types of `static` items: those declared in association with
1400 /// the [`mut`] keyword and those without.
1402 /// Static items cannot be moved:
1404 /// ```rust,compile_fail,E0507
1405 /// static VEC: Vec<u32> = vec![];
1407 /// fn move_vec(v: Vec<u32>) -> Vec<u32> {
1411 /// // This line causes an error
1415 /// # Simple `static`s
1417 /// Accessing non-[`mut`] `static` items is considered safe, but some
1418 /// restrictions apply. Most notably, the type of a `static` value needs to
1419 /// implement the [`Sync`] trait, ruling out interior mutability containers
1420 /// like [`RefCell`]. See the [Reference] for more information.
1423 /// static FOO: [i32; 5] = [1, 2, 3, 4, 5];
1425 /// let r1 = &FOO as *const _;
1426 /// let r2 = &FOO as *const _;
1427 /// // With a strictly read-only static, references will have the same address
1428 /// assert_eq!(r1, r2);
1429 /// // A static item can be used just like a variable in many cases
1430 /// println!("{:?}", FOO);
1433 /// # Mutable `static`s
1435 /// If a `static` item is declared with the [`mut`] keyword, then it is allowed
1436 /// to be modified by the program. However, accessing mutable `static`s can
1437 /// cause undefined behavior in a number of ways, for example due to data races
1438 /// in a multithreaded context. As such, all accesses to mutable `static`s
1439 /// require an [`unsafe`] block.
1441 /// Despite their unsafety, mutable `static`s are necessary in many contexts:
1442 /// they can be used to represent global state shared by the whole program or in
1443 /// [`extern`] blocks to bind to variables from C libraries.
1445 /// In an [`extern`] block:
1448 /// # #![allow(dead_code)]
1450 /// static mut ERROR_MESSAGE: *mut std::os::raw::c_char;
1454 /// Mutable `static`s, just like simple `static`s, have some restrictions that
1455 /// apply to them. See the [Reference] for more information.
1457 /// [`const`]: keyword.const.html
1458 /// [`extern`]: keyword.extern.html
1459 /// [`mut`]: keyword.mut.html
1460 /// [`unsafe`]: keyword.unsafe.html
1461 /// [`RefCell`]: cell::RefCell
1462 /// [Reference]: ../reference/items/static-items.html
1463 mod static_keyword {}
1465 #[doc(keyword = "struct")]
1467 /// A type that is composed of other types.
1469 /// Structs in Rust come in three flavors: Structs with named fields, tuple structs, and unit
1473 /// struct Regular {
1476 /// pub field3: bool
1479 /// struct Tuple(u32, String);
1484 /// Regular structs are the most commonly used. Each field defined within them has a name and a
1485 /// type, and once defined can be accessed using `example_struct.field` syntax. The fields of a
1486 /// struct share its mutability, so `foo.bar = 2;` would only be valid if `foo` was mutable. Adding
1487 /// `pub` to a field makes it visible to code in other modules, as well as allowing it to be
1488 /// directly accessed and modified.
1490 /// Tuple structs are similar to regular structs, but its fields have no names. They are used like
1491 /// tuples, with deconstruction possible via `let TupleStruct(x, y) = foo;` syntax. For accessing
1492 /// individual variables, the same syntax is used as with regular tuples, namely `foo.0`, `foo.1`,
1493 /// etc, starting at zero.
1495 /// Unit structs are most commonly used as marker. They have a size of zero bytes, but unlike empty
1496 /// enums they can be instantiated, making them isomorphic to the unit type `()`. Unit structs are
1497 /// useful when you need to implement a trait on something, but don't need to store any data inside
1502 /// Structs can be instantiated in different ways, all of which can be mixed and
1503 /// matched as needed. The most common way to make a new struct is via a constructor method such as
1504 /// `new()`, but when that isn't available (or you're writing the constructor itself), struct
1505 /// literal syntax is used:
1508 /// # struct Foo { field1: f32, field2: String, etc: bool }
1509 /// let example = Foo {
1511 /// field2: "blah".to_string(),
1516 /// It's only possible to directly instantiate a struct using struct literal syntax when all of its
1517 /// fields are visible to you.
1519 /// There are a handful of shortcuts provided to make writing constructors more convenient, most
1520 /// common of which is the Field Init shorthand. When there is a variable and a field of the same
1521 /// name, the assignment can be simplified from `field: field` into simply `field`. The following
1522 /// example of a hypothetical constructor demonstrates this:
1531 /// pub fn new(name: String) -> Self {
1540 /// Another shortcut for struct instantiation is available, used when you need to make a new
1541 /// struct that has the same values as most of a previous struct of the same type, called struct
1545 /// # struct Foo { field1: String, field2: () }
1546 /// # let thing = Foo { field1: "".to_string(), field2: () };
1547 /// let updated_thing = Foo {
1548 /// field1: "a new value".to_string(),
1553 /// Tuple structs are instantiated in the same way as tuples themselves, except with the struct's
1554 /// name as a prefix: `Foo(123, false, 0.1)`.
1556 /// Empty structs are instantiated with just their name, and don't need anything else. `let thing =
1559 /// # Style conventions
1561 /// Structs are always written in CamelCase, with few exceptions. While the trailing comma on a
1562 /// struct's list of fields can be omitted, it's usually kept for convenience in adding and
1563 /// removing fields down the line.
1565 /// For more information on structs, take a look at the [Rust Book][book] or the
1566 /// [Reference][reference].
1568 /// [`PhantomData`]: marker::PhantomData
1569 /// [book]: ../book/ch05-01-defining-structs.html
1570 /// [reference]: ../reference/items/structs.html
1571 mod struct_keyword {}
1573 #[doc(keyword = "super")]
1575 /// The parent of the current [module].
1578 /// # #![allow(dead_code)]
1585 /// super::a::foo(); // call a's foo function
1590 /// It is also possible to use `super` multiple times: `super::super::foo`,
1591 /// going up the ancestor chain.
1593 /// See the [Reference] for more information.
1595 /// [module]: ../reference/items/modules.html
1596 /// [Reference]: ../reference/paths.html#super
1597 mod super_keyword {}
1599 #[doc(keyword = "trait")]
1601 /// A common interface for a group of types.
1603 /// A `trait` is like an interface that data types can implement. When a type
1604 /// implements a trait it can be treated abstractly as that trait using generics
1605 /// or trait objects.
1607 /// Traits can be made up of three varieties of associated items:
1609 /// - functions and methods
1613 /// Traits may also contain additional type parameters. Those type parameters
1614 /// or the trait itself can be constrained by other traits.
1616 /// Traits can serve as markers or carry other logical semantics that
1617 /// aren't expressed through their items. When a type implements that
1618 /// trait it is promising to uphold its contract. [`Send`] and [`Sync`] are two
1619 /// such marker traits present in the standard library.
1621 /// See the [Reference][Ref-Traits] for a lot more information on traits.
1625 /// Traits are declared using the `trait` keyword. Types can implement them
1626 /// using [`impl`] `Trait` [`for`] `Type`:
1630 /// const ZERO: Self;
1631 /// fn is_zero(&self) -> bool;
1634 /// impl Zero for i32 {
1635 /// const ZERO: Self = 0;
1637 /// fn is_zero(&self) -> bool {
1638 /// *self == Self::ZERO
1642 /// assert_eq!(i32::ZERO, 0);
1643 /// assert!(i32::ZERO.is_zero());
1644 /// assert!(!4.is_zero());
1647 /// With an associated type:
1653 /// fn build(&self) -> Self::Built;
1657 /// Traits can be generic, with constraints or without:
1660 /// trait MaybeFrom<T> {
1661 /// fn maybe_from(value: T) -> Option<Self>
1667 /// Traits can build upon the requirements of other traits. In the example
1668 /// below `Iterator` is a **supertrait** and `ThreeIterator` is a **subtrait**:
1671 /// trait ThreeIterator: std::iter::Iterator {
1672 /// fn next_three(&mut self) -> Option<[Self::Item; 3]>;
1676 /// Traits can be used in functions, as parameters:
1679 /// # #![allow(dead_code)]
1680 /// fn debug_iter<I: Iterator>(it: I) where I::Item: std::fmt::Debug {
1681 /// for elem in it {
1682 /// println!("{:#?}", elem);
1686 /// // u8_len_1, u8_len_2 and u8_len_3 are equivalent
1688 /// fn u8_len_1(val: impl Into<Vec<u8>>) -> usize {
1689 /// val.into().len()
1692 /// fn u8_len_2<T: Into<Vec<u8>>>(val: T) -> usize {
1693 /// val.into().len()
1696 /// fn u8_len_3<T>(val: T) -> usize
1698 /// T: Into<Vec<u8>>,
1700 /// val.into().len()
1704 /// Or as return types:
1707 /// # #![allow(dead_code)]
1708 /// fn from_zero_to(v: u8) -> impl Iterator<Item = u8> {
1709 /// (0..v).into_iter()
1713 /// The use of the [`impl`] keyword in this position allows the function writer
1714 /// to hide the concrete type as an implementation detail which can change
1715 /// without breaking user's code.
1719 /// A *trait object* is an opaque value of another type that implements a set of
1720 /// traits. A trait object implements all specified traits as well as their
1721 /// supertraits (if any).
1723 /// The syntax is the following: `dyn BaseTrait + AutoTrait1 + ... AutoTraitN`.
1724 /// Only one `BaseTrait` can be used so this will not compile:
1726 /// ```rust,compile_fail,E0225
1730 /// let _: Box<dyn A + B>;
1733 /// Neither will this, which is a syntax error:
1735 /// ```rust,compile_fail
1739 /// let _: Box<dyn A + dyn B>;
1742 /// On the other hand, this is correct:
1747 /// let _: Box<dyn A + Send + Sync>;
1750 /// The [Reference][Ref-Trait-Objects] has more information about trait objects,
1751 /// their limitations and the differences between editions.
1755 /// Some traits may be unsafe to implement. Using the [`unsafe`] keyword in
1756 /// front of the trait's declaration is used to mark this:
1759 /// unsafe trait UnsafeTrait {}
1761 /// unsafe impl UnsafeTrait for i32 {}
1764 /// # Differences between the 2015 and 2018 editions
1766 /// In the 2015 edition the parameters pattern was not needed for traits:
1768 /// ```rust,edition2015
1769 /// # #![allow(anonymous_parameters)]
1775 /// This behavior is no longer valid in edition 2018.
1777 /// [`for`]: keyword.for.html
1778 /// [`impl`]: keyword.impl.html
1779 /// [`unsafe`]: keyword.unsafe.html
1780 /// [Ref-Traits]: ../reference/items/traits.html
1781 /// [Ref-Trait-Objects]: ../reference/types/trait-object.html
1782 mod trait_keyword {}
1784 #[doc(keyword = "true")]
1786 /// A value of type [`bool`] representing logical **true**.
1788 /// Logically `true` is not equal to [`false`].
1790 /// ## Control structures that check for **true**
1792 /// Several of Rust's control structures will check for a `bool` condition evaluating to **true**.
1794 /// * The condition in an [`if`] expression must be of type `bool`.
1795 /// Whenever that condition evaluates to **true**, the `if` expression takes
1796 /// on the value of the first block. If however, the condition evaluates
1797 /// to `false`, the expression takes on value of the `else` block if there is one.
1799 /// * [`while`] is another control flow construct expecting a `bool`-typed condition.
1800 /// As long as the condition evaluates to **true**, the `while` loop will continually
1801 /// evaluate its associated block.
1803 /// * [`match`] arms can have guard clauses on them.
1805 /// [`if`]: keyword.if.html
1806 /// [`while`]: keyword.while.html
1807 /// [`match`]: ../reference/expressions/match-expr.html#match-guards
1808 /// [`false`]: keyword.false.html
1811 #[doc(keyword = "type")]
1813 /// Define an alias for an existing type.
1815 /// The syntax is `type Name = ExistingType;`.
1819 /// `type` does **not** create a new type:
1822 /// type Meters = u32;
1823 /// type Kilograms = u32;
1825 /// let m: Meters = 3;
1826 /// let k: Kilograms = 3;
1828 /// assert_eq!(m, k);
1831 /// In traits, `type` is used to declare an [associated type]:
1834 /// trait Iterator {
1835 /// // associated type declaration
1837 /// fn next(&mut self) -> Option<Self::Item>;
1840 /// struct Once<T>(Option<T>);
1842 /// impl<T> Iterator for Once<T> {
1843 /// // associated type definition
1845 /// fn next(&mut self) -> Option<Self::Item> {
1851 /// [`trait`]: keyword.trait.html
1852 /// [associated type]: ../reference/items/associated-items.html#associated-types
1855 #[doc(keyword = "unsafe")]
1857 /// Code or interfaces whose [memory safety] cannot be verified by the type
1860 /// The `unsafe` keyword has two uses: to declare the existence of contracts the
1861 /// compiler can't check (`unsafe fn` and `unsafe trait`), and to declare that a
1862 /// programmer has checked that these contracts have been upheld (`unsafe {}`
1863 /// and `unsafe impl`, but also `unsafe fn` -- see below). They are not mutually
1864 /// exclusive, as can be seen in `unsafe fn`.
1866 /// # Unsafe abilities
1868 /// **No matter what, Safe Rust can't cause Undefined Behavior**. This is
1869 /// referred to as [soundness]: a well-typed program actually has the desired
1870 /// properties. The [Nomicon][nomicon-soundness] has a more detailed explanation
1873 /// To ensure soundness, Safe Rust is restricted enough that it can be
1874 /// automatically checked. Sometimes, however, it is necessary to write code
1875 /// that is correct for reasons which are too clever for the compiler to
1876 /// understand. In those cases, you need to use Unsafe Rust.
1878 /// Here are the abilities Unsafe Rust has in addition to Safe Rust:
1880 /// - Dereference [raw pointers]
1881 /// - Implement `unsafe` [`trait`]s
1882 /// - Call `unsafe` functions
1883 /// - Mutate [`static`]s (including [`extern`]al ones)
1884 /// - Access fields of [`union`]s
1886 /// However, this extra power comes with extra responsibilities: it is now up to
1887 /// you to ensure soundness. The `unsafe` keyword helps by clearly marking the
1888 /// pieces of code that need to worry about this.
1890 /// ## The different meanings of `unsafe`
1892 /// Not all uses of `unsafe` are equivalent: some are here to mark the existence
1893 /// of a contract the programmer must check, others are to say "I have checked
1894 /// the contract, go ahead and do this". The following
1895 /// [discussion on Rust Internals] has more in-depth explanations about this but
1896 /// here is a summary of the main points:
1898 /// - `unsafe fn`: calling this function means abiding by a contract the
1899 /// compiler cannot enforce.
1900 /// - `unsafe trait`: implementing the [`trait`] means abiding by a
1901 /// contract the compiler cannot enforce.
1902 /// - `unsafe {}`: the contract necessary to call the operations inside the
1903 /// block has been checked by the programmer and is guaranteed to be respected.
1904 /// - `unsafe impl`: the contract necessary to implement the trait has been
1905 /// checked by the programmer and is guaranteed to be respected.
1907 /// `unsafe fn` also acts like an `unsafe {}` block
1908 /// around the code inside the function. This means it is not just a signal to
1909 /// the caller, but also promises that the preconditions for the operations
1910 /// inside the function are upheld. Mixing these two meanings can be confusing
1911 /// and [proposal]s exist to use `unsafe {}` blocks inside such functions when
1912 /// making `unsafe` operations.
1914 /// See the [Rustnomicon] and the [Reference] for more informations.
1918 /// ## Marking elements as `unsafe`
1920 /// `unsafe` can be used on functions. Note that functions and statics declared
1921 /// in [`extern`] blocks are implicitly marked as `unsafe` (but not functions
1922 /// declared as `extern "something" fn ...`). Mutable statics are always unsafe,
1923 /// wherever they are declared. Methods can also be declared as `unsafe`:
1926 /// # #![allow(dead_code)]
1927 /// static mut FOO: &str = "hello";
1929 /// unsafe fn unsafe_fn() {}
1932 /// fn unsafe_extern_fn();
1933 /// static BAR: *mut u32;
1936 /// trait SafeTraitWithUnsafeMethod {
1937 /// unsafe fn unsafe_method(&self);
1943 /// unsafe fn unsafe_method_on_struct() {}
1947 /// Traits can also be declared as `unsafe`:
1950 /// unsafe trait UnsafeTrait {}
1953 /// Since `unsafe fn` and `unsafe trait` indicate that there is a safety
1954 /// contract that the compiler cannot enforce, documenting it is important. The
1955 /// standard library has many examples of this, like the following which is an
1956 /// extract from [`Vec::set_len`]. The `# Safety` section explains the contract
1957 /// that must be fulfilled to safely call the function.
1959 /// ```rust,ignore (stub-to-show-doc-example)
1960 /// /// Forces the length of the vector to `new_len`.
1962 /// /// This is a low-level operation that maintains none of the normal
1963 /// /// invariants of the type. Normally changing the length of a vector
1964 /// /// is done using one of the safe operations instead, such as
1965 /// /// `truncate`, `resize`, `extend`, or `clear`.
1969 /// /// - `new_len` must be less than or equal to `capacity()`.
1970 /// /// - The elements at `old_len..new_len` must be initialized.
1971 /// pub unsafe fn set_len(&mut self, new_len: usize)
1974 /// ## Using `unsafe {}` blocks and `impl`s
1976 /// Performing `unsafe` operations requires an `unsafe {}` block:
1979 /// # #![allow(dead_code)]
1980 /// /// Dereference the given pointer.
1984 /// /// `ptr` must be aligned and must not be dangling.
1985 /// unsafe fn deref_unchecked(ptr: *const i32) -> i32 {
1990 /// let b = &a as *const _;
1991 /// // SAFETY: `a` has not been dropped and references are always aligned,
1992 /// // so `b` is a valid address.
1993 /// unsafe { assert_eq!(*b, deref_unchecked(b)); };
1996 /// Traits marked as `unsafe` must be [`impl`]emented using `unsafe impl`. This
1997 /// makes a guarantee to other `unsafe` code that the implementation satisfies
1998 /// the trait's safety contract. The [Send] and [Sync] traits are examples of
1999 /// this behaviour in the standard library.
2002 /// /// Implementors of this trait must guarantee an element is always
2003 /// /// accessible with index 3.
2004 /// unsafe trait ThreeIndexable<T> {
2005 /// /// Returns a reference to the element with index 3 in `&self`.
2006 /// fn three(&self) -> &T;
2009 /// // The implementation of `ThreeIndexable` for `[T; 4]` is `unsafe`
2010 /// // because the implementor must abide by a contract the compiler cannot
2011 /// // check but as a programmer we know there will always be a valid element
2012 /// // at index 3 to access.
2013 /// unsafe impl<T> ThreeIndexable<T> for [T; 4] {
2014 /// fn three(&self) -> &T {
2015 /// // SAFETY: implementing the trait means there always is an element
2016 /// // with index 3 accessible.
2017 /// unsafe { self.get_unchecked(3) }
2021 /// let a = [1, 2, 4, 8];
2022 /// assert_eq!(a.three(), &8);
2025 /// [`extern`]: keyword.extern.html
2026 /// [`trait`]: keyword.trait.html
2027 /// [`static`]: keyword.static.html
2028 /// [`union`]: keyword.union.html
2029 /// [`impl`]: keyword.impl.html
2030 /// [raw pointers]: ../reference/types/pointer.html
2031 /// [memory safety]: ../book/ch19-01-unsafe-rust.html
2032 /// [Rustnomicon]: ../nomicon/index.html
2033 /// [nomicon-soundness]: ../nomicon/safe-unsafe-meaning.html
2034 /// [soundness]: https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#soundness-of-code--of-a-library
2035 /// [Reference]: ../reference/unsafety.html
2036 /// [proposal]: https://github.com/rust-lang/rfcs/pull/2585
2037 /// [discussion on Rust Internals]: https://internals.rust-lang.org/t/what-does-unsafe-mean/6696
2038 mod unsafe_keyword {}
2040 #[doc(keyword = "use")]
2042 /// Import or rename items from other crates or modules.
2044 /// Usually a `use` keyword is used to shorten the path required to refer to a module item.
2045 /// The keyword may appear in modules, blocks and even functions, usually at the top.
2047 /// The most basic usage of the keyword is `use path::to::item;`,
2048 /// though a number of convenient shortcuts are supported:
2050 /// * Simultaneously binding a list of paths with a common prefix,
2051 /// using the glob-like brace syntax `use a::b::{c, d, e::f, g::h::i};`
2052 /// * Simultaneously binding a list of paths with a common prefix and their common parent module,
2053 /// using the [`self`] keyword, such as `use a::b::{self, c, d::e};`
2054 /// * Rebinding the target name as a new local name, using the syntax `use p::q::r as x;`.
2055 /// This can also be used with the last two features: `use a::b::{self as ab, c as abc}`.
2056 /// * Binding all paths matching a given prefix,
2057 /// using the asterisk wildcard syntax `use a::b::*;`.
2058 /// * Nesting groups of the previous features multiple times,
2059 /// such as `use a::b::{self as ab, c, d::{*, e::f}};`
2060 /// * Reexporting with visibility modifiers such as `pub use a::b;`
2061 /// * Importing with `_` to only import the methods of a trait without binding it to a name
2062 /// (to avoid conflict for example): `use ::std::io::Read as _;`.
2064 /// Using path qualifiers like [`crate`], [`super`] or [`self`] is supported: `use crate::a::b;`.
2066 /// Note that when the wildcard `*` is used on a type, it does not import its methods (though
2067 /// for `enum`s it imports the variants, as shown in the example below).
2069 /// ```compile_fail,edition2018
2070 /// enum ExampleEnum {
2075 /// impl ExampleEnum {
2076 /// fn new() -> Self {
2081 /// use ExampleEnum::*;
2084 /// let _ = VariantA;
2086 /// // Does not compile !
2090 /// For more information on `use` and paths in general, see the [Reference].
2092 /// The differences about paths and the `use` keyword between the 2015 and 2018 editions
2093 /// can also be found in the [Reference].
2095 /// [`crate`]: keyword.crate.html
2096 /// [`self`]: keyword.self.html
2097 /// [`super`]: keyword.super.html
2098 /// [Reference]: ../reference/items/use-declarations.html
2101 #[doc(keyword = "where")]
2103 /// Add constraints that must be upheld to use an item.
2105 /// `where` allows specifying constraints on lifetime and generic parameters.
2106 /// The [RFC] introducing `where` contains detailed informations about the
2111 /// `where` can be used for constraints with traits:
2114 /// fn new<T: Default>() -> T {
2118 /// fn new_where<T>() -> T
2125 /// assert_eq!(0.0, new());
2126 /// assert_eq!(0.0, new_where());
2128 /// assert_eq!(0, new());
2129 /// assert_eq!(0, new_where());
2132 /// `where` can also be used for lifetimes.
2134 /// This compiles because `longer` outlives `shorter`, thus the constraint is
2138 /// fn select<'short, 'long>(s1: &'short str, s2: &'long str, second: bool) -> &'short str
2142 /// if second { s2 } else { s1 }
2145 /// let outer = String::from("Long living ref");
2146 /// let longer = &outer;
2148 /// let inner = String::from("Short living ref");
2149 /// let shorter = &inner;
2151 /// assert_eq!(select(shorter, longer, false), shorter);
2152 /// assert_eq!(select(shorter, longer, true), longer);
2156 /// On the other hand, this will not compile because the `where 'b: 'a` clause
2157 /// is missing: the `'b` lifetime is not known to live at least as long as `'a`
2158 /// which means this function cannot ensure it always returns a valid reference:
2160 /// ```rust,compile_fail,E0623
2161 /// fn select<'a, 'b>(s1: &'a str, s2: &'b str, second: bool) -> &'a str
2163 /// if second { s2 } else { s1 }
2167 /// `where` can also be used to express more complicated constraints that cannot
2168 /// be written with the `<T: Trait>` syntax:
2171 /// fn first_or_default<I>(mut i: I) -> I::Item
2174 /// I::Item: Default,
2176 /// i.next().unwrap_or_else(I::Item::default)
2179 /// assert_eq!(first_or_default(vec![1, 2, 3].into_iter()), 1);
2180 /// assert_eq!(first_or_default(Vec::<i32>::new().into_iter()), 0);
2183 /// `where` is available anywhere generic and lifetime parameters are available,
2184 /// as can be seen with the [`Cow`](crate::borrow::Cow) type from the standard
2188 /// # #![allow(dead_code)]
2189 /// pub enum Cow<'a, B>
2191 /// B: 'a + ToOwned + ?Sized,
2193 /// Borrowed(&'a B),
2194 /// Owned(<B as ToOwned>::Owned),
2198 /// [RFC]: https://github.com/rust-lang/rfcs/blob/master/text/0135-where.md
2199 mod where_keyword {}
2201 // 2018 Edition keywords
2203 #[doc(alias = "promise")]
2204 #[doc(keyword = "async")]
2206 /// Return a [`Future`] instead of blocking the current thread.
2208 /// Use `async` in front of `fn`, `closure`, or a `block` to turn the marked code into a `Future`.
2209 /// As such the code will not be run immediately, but will only be evaluated when the returned
2210 /// future is `.await`ed.
2212 /// We have written an [async book] detailing async/await and trade-offs compared to using threads.
2216 /// `async` is a keyword from the 2018 edition onwards.
2218 /// It is available for use in stable rust from version 1.39 onwards.
2220 /// [`Future`]: future::Future
2221 /// [async book]: https://rust-lang.github.io/async-book/
2222 mod async_keyword {}
2224 #[doc(keyword = "await")]
2226 /// Suspend execution until the result of a [`Future`] is ready.
2228 /// `.await`ing a future will suspend the current function's execution until the `executor`
2229 /// has run the future to completion.
2231 /// Read the [async book] for details on how async/await and executors work.
2235 /// `await` is a keyword from the 2018 edition onwards.
2237 /// It is available for use in stable rust from version 1.39 onwards.
2239 /// [`Future`]: future::Future
2240 /// [async book]: https://rust-lang.github.io/async-book/
2241 mod await_keyword {}
2243 #[doc(keyword = "dyn")]
2245 /// `dyn` is a prefix of a [trait object]'s type.
2247 /// The `dyn` keyword is used to highlight that calls to methods on the associated `Trait`
2248 /// are dynamically dispatched. To use the trait this way, it must be 'object safe'.
2250 /// Unlike generic parameters or `impl Trait`, the compiler does not know the concrete type that
2251 /// is being passed. That is, the type has been [erased].
2252 /// As such, a `dyn Trait` reference contains _two_ pointers.
2253 /// One pointer goes to the data (e.g., an instance of a struct).
2254 /// Another pointer goes to a map of method call names to function pointers
2255 /// (known as a virtual method table or vtable).
2257 /// At run-time, when a method needs to be called on the `dyn Trait`, the vtable is consulted to get
2258 /// the function pointer and then that function pointer is called.
2262 /// The above indirection is the additional runtime cost of calling a function on a `dyn Trait`.
2263 /// Methods called by dynamic dispatch generally cannot be inlined by the compiler.
2265 /// However, `dyn Trait` is likely to produce smaller code than `impl Trait` / generic parameters as
2266 /// the method won't be duplicated for each concrete type.
2268 /// Read more about `object safety` and [trait object]s.
2270 /// [trait object]: ../book/ch17-02-trait-objects.html
2271 /// [erased]: https://en.wikipedia.org/wiki/Type_erasure
2274 #[doc(keyword = "union")]
2276 /// The [Rust equivalent of a C-style union][union].
2278 /// A `union` looks like a [`struct`] in terms of declaration, but all of its
2279 /// fields exist in the same memory, superimposed over one another. For instance,
2280 /// if we wanted some bits in memory that we sometimes interpret as a `u32` and
2281 /// sometimes as an `f32`, we could write:
2284 /// union IntOrFloat {
2289 /// let mut u = IntOrFloat { f: 1.0 };
2290 /// // Reading the fields of an union is always unsafe
2291 /// assert_eq!(unsafe { u.i }, 1065353216);
2292 /// // Updating through any of the field will modify all of them
2293 /// u.i = 1073741824;
2294 /// assert_eq!(unsafe { u.f }, 2.0);
2297 /// # Matching on unions
2299 /// It is possible to use pattern matching on `union`s. A single field name must
2300 /// be used and it must match the name of one of the `union`'s field.
2301 /// Like reading from a `union`, pattern matching on a `union` requires `unsafe`.
2304 /// union IntOrFloat {
2309 /// let u = IntOrFloat { f: 1.0 };
2313 /// IntOrFloat { i: 10 } => println!("Found exactly ten!"),
2314 /// // Matching the field `f` provides an `f32`.
2315 /// IntOrFloat { f } => println!("Found f = {} !", f),
2320 /// # References to union fields
2322 /// All fields in a `union` are all at the same place in memory which means
2323 /// borrowing one borrows the entire `union`, for the same lifetime:
2325 /// ```rust,compile_fail,E0502
2326 /// union IntOrFloat {
2331 /// let mut u = IntOrFloat { f: 1.0 };
2333 /// let f = unsafe { &u.f };
2334 /// // This will not compile because the field has already been borrowed, even
2335 /// // if only immutably
2336 /// let i = unsafe { &mut u.i };
2339 /// println!("f = {} and i = {}", f, i);
2342 /// See the [Reference][union] for more informations on `union`s.
2344 /// [`struct`]: keyword.struct.html
2345 /// [union]: ../reference/items/unions.html
2346 mod union_keyword {}