keyword_docs.rs.html -- source
Description: Source to the Rust file `libstd/keyword_docs.rs`.
Keywords: rust, rustlang, rust-lang

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79

    // Copyright 2018 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    #[doc(keyword = "fn")]
    //
    /// The `fn` keyword.
    ///
    /// The `fn` keyword is used to declare a function.
    ///
    /// Example:
    ///
    /// ```rust
    /// fn some_function() {
    ///     // code goes in here
    /// }
    /// ```
    ///
    /// For more information about functions, take a look at the [Rust Book][book].
    ///
    /// [book]: https://doc.rust-lang.org/book/second-edition/ch03-03-how-functions-work.html
    mod fn_keyword { }

    #[doc(keyword = "let")]
    //
    /// The `let` keyword.
    ///
    /// The `let` keyword is used to declare a variable.
    ///
    /// Example:
    ///
    /// ```rust
    /// # #![allow(unused_assignments)]
    /// let x = 3; // We create a variable named `x` with the value `3`.
    /// ```
    ///
    /// By default, all variables are **not** mutable. If you want a mutable variable,
    /// you'll have to use the `mut` keyword.
    ///
    /// Example:
    ///
    /// ```rust
    /// # #![allow(unused_assignments)]
    /// let mut x = 3; // We create a mutable variable named `x` with the value `3`.
    ///
    /// x += 4; // `x` is now equal to `7`.
    /// ```
    ///
    /// For more information about the `let` keyword, take a look at the [Rust Book][book].
    ///
    /// [book]: https://doc.rust-lang.org/book/second-edition/ch03-01-variables-and-mutability.html
    mod let_keyword { }

    #[doc(keyword = "struct")]
    //
    /// The `struct` keyword.
    ///
    /// The `struct` keyword is used to define a struct type.
    ///
    /// Example:
    ///
    /// ```
    /// struct Foo {
    ///     field1: u32,
    ///     field2: String,
    /// }
    /// ```
    ///
    /// There are different kinds of structs. For more information, take a look at the
    /// [Rust Book][book].
    ///
    /// [book]: https://doc.rust-lang.org/book/second-edition/ch05-01-defining-structs.html
    mod struct_keyword { }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)