5 This document is the primary reference for the Rust programming language. It
6 provides three kinds of material:
8 - Chapters that formally define the language grammar and, for each
9 construct, informally describe its semantics and give examples of its
11 - Chapters that informally describe the memory model, concurrency model,
12 runtime services, linkage model and debugging facilities.
13 - Appendix chapters providing rationale and references to languages that
14 influenced the design.
16 This document does not serve as an introduction to the language. Background
17 familiarity with the language is assumed. A separate [book] is available to
18 help acquire such background familiarity.
20 This document also does not serve as a reference to the [standard] library
21 included in the language distribution. Those libraries are documented
22 separately by extracting documentation attributes from their source code. Many
23 of the features that one might expect to be language features are library
24 features in Rust, so what you're looking for may be there, not here.
26 [book]: book/index.html
27 [standard]: std/index.html
31 Rust's grammar is defined over Unicode codepoints, each conventionally denoted
32 `U+XXXX`, for 4 or more hexadecimal digits `X`. _Most_ of Rust's grammar is
33 confined to the ASCII range of Unicode, and is described in this document by a
34 dialect of Extended Backus-Naur Form (EBNF), specifically a dialect of EBNF
35 supported by common automated LL(k) parsing tools such as `llgen`, rather than
36 the dialect given in ISO 14977. The dialect can be defined self-referentially
41 rule : nonterminal ':' productionrule ';' ;
42 productionrule : production [ '|' production ] * ;
44 term : element repeats ;
45 element : LITERAL | IDENTIFIER | '[' productionrule ']' ;
46 repeats : [ '*' | '+' ] NUMBER ? | NUMBER ? | '?' ;
51 - Whitespace in the grammar is ignored.
52 - Square brackets are used to group rules.
53 - `LITERAL` is a single printable ASCII character, or an escaped hexadecimal
54 ASCII code of the form `\xQQ`, in single quotes, denoting the corresponding
55 Unicode codepoint `U+00QQ`.
56 - `IDENTIFIER` is a nonempty string of ASCII letters and underscores.
57 - The `repeat` forms apply to the adjacent `element`, and are as follows:
58 - `?` means zero or one repetition
59 - `*` means zero or more repetitions
60 - `+` means one or more repetitions
61 - NUMBER trailing a repeat symbol gives a maximum repetition count
62 - NUMBER on its own gives an exact repetition count
64 This EBNF dialect should hopefully be familiar to many readers.
66 ## Unicode productions
68 A few productions in Rust's grammar permit Unicode codepoints outside the ASCII
69 range. We define these productions in terms of character properties specified
70 in the Unicode standard, rather than in terms of ASCII-range codepoints. The
71 section [Special Unicode Productions](#special-unicode-productions) lists these
74 ## String table productions
76 Some rules in the grammar — notably [unary
77 operators](#unary-operator-expressions), [binary
78 operators](#binary-operator-expressions), and [keywords](#keywords) — are
79 given in a simplified form: as a listing of a table of unquoted, printable
80 whitespace-separated strings. These cases form a subset of the rules regarding
81 the [token](#tokens) rule, and are assumed to be the result of a
82 lexical-analysis phase feeding the parser, driven by a DFA, operating over the
83 disjunction of all such string table entries.
85 When such a string enclosed in double-quotes (`"`) occurs inside the grammar,
86 it is an implicit reference to a single member of such a string table
87 production. See [tokens](#tokens) for more information.
93 Rust input is interpreted as a sequence of Unicode codepoints encoded in UTF-8.
94 Most Rust grammar rules are defined in terms of printable ASCII-range
95 codepoints, but a small number are defined in terms of Unicode properties or
96 explicit codepoint lists. [^inputformat]
98 [^inputformat]: Substitute definitions for the special Unicode productions are
99 provided to the grammar verifier, restricted to ASCII range, when verifying the
100 grammar in this document.
102 ## Special Unicode Productions
104 The following productions in the Rust grammar are defined in terms of Unicode
105 properties: `ident`, `non_null`, `non_star`, `non_eol`, `non_slash_or_star`,
106 `non_single_quote` and `non_double_quote`.
110 The `ident` production is any nonempty Unicode string of the following form:
112 - The first character has property `XID_start`
113 - The remaining characters have property `XID_continue`
115 that does _not_ occur in the set of [keywords](#keywords).
117 > **Note**: `XID_start` and `XID_continue` as character properties cover the
118 > character ranges used to form the more familiar C and Java language-family
121 ### Delimiter-restricted productions
123 Some productions are defined by exclusion of particular Unicode characters:
125 - `non_null` is any single Unicode character aside from `U+0000` (null)
126 - `non_eol` is `non_null` restricted to exclude `U+000A` (`'\n'`)
127 - `non_star` is `non_null` restricted to exclude `U+002A` (`*`)
128 - `non_slash_or_star` is `non_null` restricted to exclude `U+002F` (`/`) and `U+002A` (`*`)
129 - `non_single_quote` is `non_null` restricted to exclude `U+0027` (`'`)
130 - `non_double_quote` is `non_null` restricted to exclude `U+0022` (`"`)
135 comment : block_comment | line_comment ;
136 block_comment : "/*" block_comment_body * "*/" ;
137 block_comment_body : [block_comment | character] * ;
138 line_comment : "//" non_eol * ;
141 Comments in Rust code follow the general C++ style of line and block-comment
142 forms. Nested block comments are supported.
144 Line comments beginning with exactly _three_ slashes (`///`), and block
145 comments beginning with exactly one repeated asterisk in the block-open
146 sequence (`/**`), are interpreted as a special syntax for `doc`
147 [attributes](#attributes). That is, they are equivalent to writing
148 `#[doc="..."]` around the body of the comment (this includes the comment
149 characters themselves, ie `/// Foo` turns into `#[doc="/// Foo"]`).
151 `//!` comments apply to the parent of the comment, rather than the item that
152 follows. `//!` comments are usually used to display information on the crate
155 Non-doc comments are interpreted as a form of whitespace.
160 whitespace_char : '\x20' | '\x09' | '\x0a' | '\x0d' ;
161 whitespace : [ whitespace_char | comment ] + ;
164 The `whitespace_char` production is any nonempty Unicode string consisting of
165 any of the following Unicode characters: `U+0020` (space, `' '`), `U+0009`
166 (tab, `'\t'`), `U+000A` (LF, `'\n'`), `U+000D` (CR, `'\r'`).
168 Rust is a "free-form" language, meaning that all forms of whitespace serve only
169 to separate _tokens_ in the grammar, and have no semantic significance.
171 A Rust program has identical meaning if each whitespace element is replaced
172 with any other legal whitespace element, such as a single space character.
177 simple_token : keyword | unop | binop ;
178 token : simple_token | ident | literal | symbol | whitespace token ;
181 Tokens are primitive productions in the grammar defined by regular
182 (non-recursive) languages. "Simple" tokens are given in [string table
183 production](#string-table-productions) form, and occur in the rest of the
184 grammar as double-quoted strings. Other tokens have exact rules given.
188 <p id="keyword-table-marker"></p>
191 |----------|----------|----------|----------|---------|
192 | abstract | alignof | as | be | box |
193 | break | const | continue | crate | do |
194 | else | enum | extern | false | final |
195 | fn | for | if | impl | in |
196 | let | loop | macro | match | mod |
197 | move | mut | offsetof | override | priv |
198 | pub | pure | ref | return | sizeof |
199 | static | self | struct | super | true |
200 | trait | type | typeof | unsafe | unsized |
201 | use | virtual | where | while | yield |
204 Each of these keywords has special meaning in its grammar, and all of them are
205 excluded from the `ident` rule.
207 Note that some of these keywords are reserved, and do not currently do
212 A literal is an expression consisting of a single token, rather than a sequence
213 of tokens, that immediately and directly denotes the value it evaluates to,
214 rather than referring to it by name or some other evaluation rule. A literal is
215 a form of constant expression, so is evaluated (primarily) at compile time.
219 literal : [ string_lit | char_lit | byte_string_lit | byte_lit | num_lit ] lit_suffix ?;
222 The optional suffix is only used for certain numeric literals, but is
223 reserved for future extension, that is, the above gives the lexical
224 grammar, but a Rust parser will reject everything but the 12 special
225 cases mentioned in [Number literals](#number-literals) below.
229 ##### Characters and strings
231 | | Example | Number of `#` pairs allowed | Available characters | Escapes | Equivalent to |
232 |---|---------|-----------------------------|----------------------|---------|---------------|
233 | [Character](#character-literals) | `'H'` | `N/A` | All unicode | `\'` & [Byte escapes](#byte-escapes) & [Unicode escapes](#unicode-escapes) | `N/A` |
234 | [String](#string-literals) | `"hello"` | `N/A` | All unicode | `\"` & [Byte escapes](#byte-escapes) & [Unicode escapes](#unicode-escapes) | `N/A` |
235 | [Raw](#raw-string-literals) | `r##"hello"##` | `0...` | All unicode | `N/A` | `N/A` |
236 | [Byte](#byte-literals) | `b'H'` | `N/A` | All ASCII | `\'` & [Byte escapes](#byte-escapes) | `u8` |
237 | [Byte string](#byte-string-literals) | `b"hello"` | `N/A` | All ASCII | `\"` & [Byte escapes](#byte-escapes) | `&'static [u8]` |
238 | [Raw byte string](#raw-byte-string-literals) | `br##"hello"##` | `0...` | All ASCII | `N/A` | `&'static [u8]` (unsure...not stated) |
244 | `\x7F` | 8-bit character code (exactly 2 digits) |
246 | `\r` | Carriage return |
250 ##### Unicode escapes
253 | `\u7FFF` | 16-bit character code (exactly 4 digits) |
254 | `\U7EEEFFFF` | 32-bit character code (exactly 8 digits) |
258 | [Number literals](#number-literals)`*` | Example | Exponentiation | Suffixes |
259 |----------------------------------------|---------|----------------|----------|
260 | Decimal integer | `98_222i` | `N/A` | Integer suffixes |
261 | Hex integer | `0xffi` | `N/A` | Integer suffixes |
262 | Octal integer | `0o77i` | `N/A` | Integer suffixes |
263 | Binary integer | `0b1111_0000i` | `N/A` | Integer suffixes |
264 | Floating-point | `123.0E+77f64` | `Optional` | Floating-point suffixes |
266 `*` All number literals allow `_` as a visual separator: `1_234.0E+18f64`
269 | Integer | Floating-point |
270 |---------|----------------|
271 | `i` (`int`), `u` (`uint`), `u8`, `i8`, `u16`, `i16`, `u32`, `i32`, `u64`, `i64` | `f32`, `f64` |
273 #### Character and string literals
276 char_lit : '\x27' char_body '\x27' ;
277 string_lit : '"' string_body * '"' | 'r' raw_string ;
279 char_body : non_single_quote
280 | '\x5c' [ '\x27' | common_escape | unicode_escape ] ;
282 string_body : non_double_quote
283 | '\x5c' [ '\x22' | common_escape | unicode_escape ] ;
284 raw_string : '"' raw_string_body '"' | '#' raw_string '#' ;
286 common_escape : '\x5c'
287 | 'n' | 'r' | 't' | '0'
289 unicode_escape : 'u' hex_digit 4
292 hex_digit : 'a' | 'b' | 'c' | 'd' | 'e' | 'f'
293 | 'A' | 'B' | 'C' | 'D' | 'E' | 'F'
295 oct_digit : '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' ;
296 dec_digit : '0' | nonzero_dec ;
297 nonzero_dec: '1' | '2' | '3' | '4'
298 | '5' | '6' | '7' | '8' | '9' ;
301 ##### Character literals
303 A _character literal_ is a single Unicode character enclosed within two
304 `U+0027` (single-quote) characters, with the exception of `U+0027` itself,
305 which must be _escaped_ by a preceding U+005C character (`\`).
307 ##### String literals
309 A _string literal_ is a sequence of any Unicode characters enclosed within two
310 `U+0022` (double-quote) characters, with the exception of `U+0022` itself,
311 which must be _escaped_ by a preceding `U+005C` character (`\`), or a _raw
314 ##### Character escapes
316 Some additional _escapes_ are available in either character or non-raw string
317 literals. An escape starts with a `U+005C` (`\`) and continues with one of the
320 * An _8-bit codepoint escape_ escape starts with `U+0078` (`x`) and is
321 followed by exactly two _hex digits_. It denotes the Unicode codepoint
322 equal to the provided hex value.
323 * A _16-bit codepoint escape_ starts with `U+0075` (`u`) and is followed
324 by exactly four _hex digits_. It denotes the Unicode codepoint equal to
325 the provided hex value.
326 * A _32-bit codepoint escape_ starts with `U+0055` (`U`) and is followed
327 by exactly eight _hex digits_. It denotes the Unicode codepoint equal to
328 the provided hex value.
329 * A _whitespace escape_ is one of the characters `U+006E` (`n`), `U+0072`
330 (`r`), or `U+0074` (`t`), denoting the unicode values `U+000A` (LF),
331 `U+000D` (CR) or `U+0009` (HT) respectively.
332 * The _backslash escape_ is the character `U+005C` (`\`) which must be
333 escaped in order to denote *itself*.
335 ##### Raw string literals
337 Raw string literals do not process any escapes. They start with the character
338 `U+0072` (`r`), followed by zero or more of the character `U+0023` (`#`) and a
339 `U+0022` (double-quote) character. The _raw string body_ is not defined in the
340 EBNF grammar above: it can contain any sequence of Unicode characters and is
341 terminated only by another `U+0022` (double-quote) character, followed by the
342 same number of `U+0023` (`#`) characters that preceded the opening `U+0022`
343 (double-quote) character.
345 All Unicode characters contained in the raw string body represent themselves,
346 the characters `U+0022` (double-quote) (except when followed by at least as
347 many `U+0023` (`#`) characters as were used to start the raw string literal) or
348 `U+005C` (`\`) do not have any special meaning.
350 Examples for string literals:
353 "foo"; r"foo"; // foo
354 "\"foo\""; r#""foo""#; // "foo"
357 r##"foo #"# bar"##; // foo #"# bar
359 "\x52"; "R"; r"R"; // R
360 "\\x52"; r"\x52"; // \x52
363 #### Byte and byte string literals
366 byte_lit : "b\x27" byte_body '\x27' ;
367 byte_string_lit : "b\x22" string_body * '\x22' | "br" raw_byte_string ;
369 byte_body : ascii_non_single_quote
370 | '\x5c' [ '\x27' | common_escape ] ;
372 byte_string_body : ascii_non_double_quote
373 | '\x5c' [ '\x22' | common_escape ] ;
374 raw_byte_string : '"' raw_byte_string_body '"' | '#' raw_byte_string '#' ;
380 A _byte literal_ is a single ASCII character (in the `U+0000` to `U+007F`
381 range) enclosed within two `U+0027` (single-quote) characters, with the
382 exception of `U+0027` itself, which must be _escaped_ by a preceding U+005C
383 character (`\`), or a single _escape_. It is equivalent to a `u8` unsigned
384 8-bit integer _number literal_.
386 ##### Byte string literals
388 A _byte string literal_ is a sequence of ASCII characters and _escapes_
389 enclosed within two `U+0022` (double-quote) characters, with the exception of
390 `U+0022` itself, which must be _escaped_ by a preceding `U+005C` character
391 (`\`), or a _raw byte string literal_. It is equivalent to a `&'static [u8]`
392 borrowed array of unsigned 8-bit integers.
394 Some additional _escapes_ are available in either byte or non-raw byte string
395 literals. An escape starts with a `U+005C` (`\`) and continues with one of the
398 * An _byte escape_ escape starts with `U+0078` (`x`) and is
399 followed by exactly two _hex digits_. It denotes the byte
400 equal to the provided hex value.
401 * A _whitespace escape_ is one of the characters `U+006E` (`n`), `U+0072`
402 (`r`), or `U+0074` (`t`), denoting the bytes values `0x0A` (ASCII LF),
403 `0x0D` (ASCII CR) or `0x09` (ASCII HT) respectively.
404 * The _backslash escape_ is the character `U+005C` (`\`) which must be
405 escaped in order to denote its ASCII encoding `0x5C`.
407 ##### Raw byte string literals
409 Raw byte string literals do not process any escapes. They start with the
410 character `U+0062` (`b`), followed by `U+0072` (`r`), followed by zero or more
411 of the character `U+0023` (`#`), and a `U+0022` (double-quote) character. The
412 _raw string body_ is not defined in the EBNF grammar above: it can contain any
413 sequence of ASCII characters and is terminated only by another `U+0022`
414 (double-quote) character, followed by the same number of `U+0023` (`#`)
415 characters that preceded the opening `U+0022` (double-quote) character. A raw
416 byte string literal can not contain any non-ASCII byte.
418 All characters contained in the raw string body represent their ASCII encoding,
419 the characters `U+0022` (double-quote) (except when followed by at least as
420 many `U+0023` (`#`) characters as were used to start the raw string literal) or
421 `U+005C` (`\`) do not have any special meaning.
423 Examples for byte string literals:
426 b"foo"; br"foo"; // foo
427 b"\"foo\""; br#""foo""#; // "foo"
430 br##"foo #"# bar"##; // foo #"# bar
432 b"\x52"; b"R"; br"R"; // R
433 b"\\x52"; br"\x52"; // \x52
439 num_lit : nonzero_dec [ dec_digit | '_' ] * float_suffix ?
440 | '0' [ [ dec_digit | '_' ] * float_suffix ?
441 | 'b' [ '1' | '0' | '_' ] +
442 | 'o' [ oct_digit | '_' ] +
443 | 'x' [ hex_digit | '_' ] + ] ;
445 float_suffix : [ exponent | '.' dec_lit exponent ? ] ? ;
447 exponent : ['E' | 'e'] ['-' | '+' ] ? dec_lit ;
448 dec_lit : [ dec_digit | '_' ] + ;
451 A _number literal_ is either an _integer literal_ or a _floating-point
452 literal_. The grammar for recognizing the two kinds of literals is mixed.
454 ##### Integer literals
456 An _integer literal_ has one of four forms:
458 * A _decimal literal_ starts with a *decimal digit* and continues with any
459 mixture of *decimal digits* and _underscores_.
460 * A _hex literal_ starts with the character sequence `U+0030` `U+0078`
461 (`0x`) and continues as any mixture of hex digits and underscores.
462 * An _octal literal_ starts with the character sequence `U+0030` `U+006F`
463 (`0o`) and continues as any mixture of octal digits and underscores.
464 * A _binary literal_ starts with the character sequence `U+0030` `U+0062`
465 (`0b`) and continues as any mixture of binary digits and underscores.
467 Like any literal, an integer literal may be followed (immediately,
468 without any spaces) by an _integer suffix_, which forcibly sets the
469 type of the literal. There are 10 valid values for an integer suffix:
471 * The `i` and `u` suffixes give the literal type `int` or `uint`,
473 * Each of the signed and unsigned machine types `u8`, `i8`,
474 `u16`, `i16`, `u32`, `i32`, `u64` and `i64`
475 give the literal the corresponding machine type.
477 The type of an _unsuffixed_ integer literal is determined by type inference.
478 If an integer type can be _uniquely_ determined from the surrounding program
479 context, the unsuffixed integer literal has that type. If the program context
480 underconstrains the type, it is considered a static type error; if the program
481 context overconstrains the type, it is also considered a static type error.
483 Examples of integer literals of various forms:
490 0o70_i16; // type i16
491 0b1111_1111_1001_0000_i32; // type i32
494 ##### Floating-point literals
496 A _floating-point literal_ has one of two forms:
498 * A _decimal literal_ followed by a period character `U+002E` (`.`). This is
499 optionally followed by another decimal literal, with an optional _exponent_.
500 * A single _decimal literal_ followed by an _exponent_.
502 By default, a floating-point literal has a generic type, and, like integer
503 literals, the type must be uniquely determined from the context. There are two valid
504 _floating-point suffixes_, `f32` and `f64` (the 32-bit and 64-bit floating point
505 types), which explicitly determine the type of the literal.
507 Examples of floating-point literals of various forms:
510 123.0f64; // type f64
513 12E+99_f64; // type f64
514 let x: f64 = 2.; // type f64
517 This last example is different because it is not possible to use the suffix
518 syntax with a floating point literal ending in a period. `2.f64` would attempt
519 to call a method named `f64` on `2`.
521 #### Boolean literals
523 The two values of the boolean type are written `true` and `false`.
529 | '#' | '[' | ']' | '(' | ')' | '{' | '}'
533 Symbols are a general class of printable [token](#tokens) that play structural
534 roles in a variety of grammar productions. They are catalogued here for
535 completeness as the set of remaining miscellaneous printable tokens that do not
536 otherwise appear as [unary operators](#unary-operator-expressions), [binary
537 operators](#binary-operator-expressions), or [keywords](#keywords).
543 expr_path : [ "::" ] ident [ "::" expr_path_tail ] + ;
544 expr_path_tail : '<' type_expr [ ',' type_expr ] + '>'
547 type_path : ident [ type_path_tail ] + ;
548 type_path_tail : '<' type_expr [ ',' type_expr ] + '>'
552 A _path_ is a sequence of one or more path components _logically_ separated by
553 a namespace qualifier (`::`). If a path consists of only one component, it may
554 refer to either an [item](#items) or a [slot](#memory-slots) in a local control
555 scope. If a path has multiple components, it refers to an item.
557 Every item has a _canonical path_ within its crate, but the path naming an item
558 is only meaningful within a given crate. There is no global namespace across
559 crates; an item's canonical path merely identifies it within the crate.
561 Two examples of simple paths consisting of only identifier components:
568 Path components are usually [identifiers](#identifiers), but the trailing
569 component of a path may be an angle-bracket-enclosed list of type arguments. In
570 [expression](#expressions) context, the type argument list is given after a
571 final (`::`) namespace qualifier in order to disambiguate it from a relational
572 expression involving the less-than symbol (`<`). In type expression context,
573 the final namespace qualifier is omitted.
575 Two examples of paths with type arguments:
578 # struct HashMap<K, V>;
580 # fn id<T>(t: T) -> T { t }
581 type T = HashMap<int,String>; // Type arguments used in a type expression
582 let x = id::<int>(10); // Type arguments used in a call expression
586 Paths can be denoted with various leading qualifiers to change the meaning of
589 * Paths starting with `::` are considered to be global paths where the
590 components of the path start being resolved from the crate root. Each
591 identifier in the path must resolve to an item.
599 ::a::foo(); // call a's foo function
605 * Paths starting with the keyword `super` begin resolution relative to the
606 parent module. Each further identifier must resolve to an item.
614 super::a::foo(); // call a's foo function
620 * Paths starting with the keyword `self` begin resolution relative to the
621 current module. Each further identifier must resolve to an item.
633 A number of minor features of Rust are not central enough to have their own
634 syntax, and yet are not implementable as functions. Instead, they are given
635 names, and invoked through a consistent syntax: `name!(...)`. Examples include:
637 * `format!` : format data into a string
638 * `env!` : look up an environment variable's value at compile time
639 * `file!`: return the path to the file being compiled
640 * `stringify!` : pretty-print the Rust expression given as an argument
641 * `include!` : include the Rust expression in the given file
642 * `include_str!` : include the contents of the given file as a string
643 * `include_bytes!` : include the contents of the given file as a binary blob
644 * `error!`, `warn!`, `info!`, `debug!` : provide diagnostic information.
646 All of the above extensions are expressions with values.
648 Users of `rustc` can define new syntax extensions in two ways:
650 * [Compiler plugins](book/syntax-extensions.html) can include arbitrary
651 Rust code that manipulates syntax trees at compile time.
653 * [Macros](book/macros.html) define new syntax in a higher-level,
659 expr_macro_rules : "macro_rules" '!' ident '(' macro_rule * ')' ;
660 macro_rule : '(' matcher * ')' "=>" '(' transcriber * ')' ';' ;
661 matcher : '(' matcher * ')' | '[' matcher * ']'
662 | '{' matcher * '}' | '$' ident ':' ident
663 | '$' '(' matcher * ')' sep_token? [ '*' | '+' ]
664 | non_special_token ;
665 transcriber : '(' transcriber * ')' | '[' transcriber * ']'
666 | '{' transcriber * '}' | '$' ident
667 | '$' '(' transcriber * ')' sep_token? [ '*' | '+' ]
668 | non_special_token ;
671 `macro_rules` allows users to define syntax extension in a declarative way. We
672 call such extensions "macros by example" or simply "macros" — to be distinguished
673 from the "procedural macros" defined in [compiler plugins][plugin].
675 Currently, macros can expand to expressions, statements, items, or patterns.
677 (A `sep_token` is any token other than `*` and `+`. A `non_special_token` is
678 any token other than a delimiter or `$`.)
680 The macro expander looks up macro invocations by name, and tries each macro
681 rule in turn. It transcribes the first successful match. Matching and
682 transcription are closely related to each other, and we will describe them
687 The macro expander matches and transcribes every token that does not begin with
688 a `$` literally, including delimiters. For parsing reasons, delimiters must be
689 balanced, but they are otherwise not special.
691 In the matcher, `$` _name_ `:` _designator_ matches the nonterminal in the Rust
692 syntax named by _designator_. Valid designators are `item`, `block`, `stmt`,
693 `pat`, `expr`, `ty` (type), `ident`, `path`, `tt` (either side of the `=>`
694 in macro rules). In the transcriber, the designator is already known, and so
695 only the name of a matched nonterminal comes after the dollar sign.
697 In both the matcher and transcriber, the Kleene star-like operator indicates
698 repetition. The Kleene star operator consists of `$` and parens, optionally
699 followed by a separator token, followed by `*` or `+`. `*` means zero or more
700 repetitions, `+` means at least one repetition. The parens are not matched or
701 transcribed. On the matcher side, a name is bound to _all_ of the names it
702 matches, in a structure that mimics the structure of the repetition encountered
703 on a successful match. The job of the transcriber is to sort that structure
706 The rules for transcription of these repetitions are called "Macro By Example".
707 Essentially, one "layer" of repetition is discharged at a time, and all of them
708 must be discharged by the time a name is transcribed. Therefore, `( $( $i:ident
709 ),* ) => ( $i )` is an invalid macro, but `( $( $i:ident ),* ) => ( $( $i:ident
710 ),* )` is acceptable (if trivial).
712 When Macro By Example encounters a repetition, it examines all of the `$`
713 _name_ s that occur in its body. At the "current layer", they all must repeat
714 the same number of times, so ` ( $( $i:ident ),* ; $( $j:ident ),* ) => ( $(
715 ($i,$j) ),* )` is valid if given the argument `(a,b,c ; d,e,f)`, but not
716 `(a,b,c ; d,e)`. The repetition walks through the choices at that layer in
717 lockstep, so the former input transcribes to `( (a,d), (b,e), (c,f) )`.
719 Nested repetitions are allowed.
721 ### Parsing limitations
723 The parser used by the macro system is reasonably powerful, but the parsing of
724 Rust syntax is restricted in two ways:
726 1. The parser will always parse as much as possible. If it attempts to match
727 `$i:expr [ , ]` against `8 [ , ]`, it will attempt to parse `i` as an array
728 index operation and fail. Adding a separator can solve this problem.
729 2. The parser must have eliminated all ambiguity by the time it reaches a `$`
730 _name_ `:` _designator_. This requirement most often affects name-designator
731 pairs when they occur at the beginning of, or immediately after, a `$(...)*`;
732 requiring a distinctive token in front can solve the problem.
734 ## Syntax extensions useful for the macro author
736 * `log_syntax!` : print out the arguments at compile time
737 * `trace_macros!` : supply `true` or `false` to enable or disable macro expansion logging
738 * `stringify!` : turn the identifier argument into a string literal
739 * `concat!` : concatenates a comma-separated list of literals
740 * `concat_idents!` : create a new identifier by concatenating the arguments
742 # Crates and source files
744 Rust is a *compiled* language. Its semantics obey a *phase distinction*
745 between compile-time and run-time. Those semantic rules that have a *static
746 interpretation* govern the success or failure of compilation. We refer to
747 these rules as "static semantics". Semantic rules called "dynamic semantics"
748 govern the behavior of programs at run-time. A program that fails to compile
749 due to violation of a compile-time rule has no defined dynamic semantics; the
750 compiler should halt with an error report, and produce no executable artifact.
752 The compilation model centers on artifacts called _crates_. Each compilation
753 processes a single crate in source form, and if successful, produces a single
754 crate in binary form: either an executable or a library.[^cratesourcefile]
756 [^cratesourcefile]: A crate is somewhat analogous to an *assembly* in the
757 ECMA-335 CLI model, a *library* in the SML/NJ Compilation Manager, a *unit*
758 in the Owens and Flatt module system, or a *configuration* in Mesa.
760 A _crate_ is a unit of compilation and linking, as well as versioning,
761 distribution and runtime loading. A crate contains a _tree_ of nested
762 [module](#modules) scopes. The top level of this tree is a module that is
763 anonymous (from the point of view of paths within the module) and any item
764 within a crate has a canonical [module path](#paths) denoting its location
765 within the crate's module tree.
767 The Rust compiler is always invoked with a single source file as input, and
768 always produces a single output crate. The processing of that source file may
769 result in other source files being loaded as modules. Source files have the
772 A Rust source file describes a module, the name and location of which —
773 in the module tree of the current crate — are defined from outside the
774 source file: either by an explicit `mod_item` in a referencing source file, or
775 by the name of the crate itself.
777 Each source file contains a sequence of zero or more `item` definitions, and
778 may optionally begin with any number of `attributes` that apply to the
779 containing module. Attributes on the anonymous crate module define important
780 metadata that influences the behavior of the compiler.
783 # #![allow(unused_attribute)]
785 #![crate_name = "projx"]
787 // Specify the output type
788 #![crate_type = "lib"]
791 #![warn(non_camel_case_types)]
794 A crate that contains a `main` function can be compiled to an executable. If a
795 `main` function is present, its return type must be [`unit`](#primitive-types)
796 and it must take no arguments.
798 # Items and attributes
800 Crates contain [items](#items), each of which may have some number of
801 [attributes](#attributes) attached to it.
806 item : mod_item | fn_item | type_item | struct_item | enum_item
807 | static_item | trait_item | impl_item | extern_block ;
810 An _item_ is a component of a crate; some module items can be defined in crate
811 files, but most are defined in source files. Items are organized within a crate
812 by a nested set of [modules](#modules). Every crate has a single "outermost"
813 anonymous module; all further items within the crate have [paths](#paths)
814 within the module tree of the crate.
816 Items are entirely determined at compile-time, generally remain fixed during
817 execution, and may reside in read-only memory.
819 There are several kinds of item:
821 * [modules](#modules)
822 * [functions](#functions)
823 * [type definitions](#type-definitions)
824 * [structures](#structures)
825 * [enumerations](#enumerations)
826 * [static items](#static-items)
828 * [implementations](#implementations)
830 Some items form an implicit scope for the declaration of sub-items. In other
831 words, within a function or module, declarations of items can (in many cases)
832 be mixed with the statements, control blocks, and similar artifacts that
833 otherwise compose the item body. The meaning of these scoped items is the same
834 as if the item was declared outside the scope — it is still a static item
835 — except that the item's *path name* within the module namespace is
836 qualified by the name of the enclosing item, or is private to the enclosing
837 item (in the case of functions). The grammar specifies the exact locations in
838 which sub-item declarations may appear.
842 All items except modules may be *parameterized* by type. Type parameters are
843 given as a comma-separated list of identifiers enclosed in angle brackets
844 (`<...>`), after the name of the item and before its definition. The type
845 parameters of an item are considered "part of the name", not part of the type
846 of the item. A referencing [path](#paths) must (in principle) provide type
847 arguments as a list of comma-separated types enclosed within angle brackets, in
848 order to refer to the type-parameterized item. In practice, the type-inference
849 system can usually infer such argument types from context. There are no
850 general type-parametric types, only type-parametric items. That is, Rust has
851 no notion of type abstraction: there are no first-class "forall" types.
856 mod_item : "mod" ident ( ';' | '{' mod '}' );
857 mod : [ view_item | item ] * ;
860 A module is a container for zero or more [view items](#view-items) and zero or
861 more [items](#items). The view items manage the visibility of the items defined
862 within the module, as well as the visibility of names from outside the module
863 when referenced from inside the module.
865 A _module item_ is a module, surrounded in braces, named, and prefixed with the
866 keyword `mod`. A module item introduces a new, named module into the tree of
867 modules making up a crate. Modules can nest arbitrarily.
869 An example of a module:
873 type Complex = (f64, f64);
874 fn sin(f: f64) -> f64 {
878 fn cos(f: f64) -> f64 {
882 fn tan(f: f64) -> f64 {
889 Modules and types share the same namespace. Declaring a named type with
890 the same name as a module in scope is forbidden: that is, a type definition,
891 trait, struct, enumeration, or type parameter can't shadow the name of a module
892 in scope, or vice versa.
894 A module without a body is loaded from an external file, by default with the
895 same name as the module, plus the `.rs` extension. When a nested submodule is
896 loaded from an external file, it is loaded from a subdirectory path that
897 mirrors the module hierarchy.
900 // Load the `vec` module from `vec.rs`
904 // Load the `local_data` module from `thread/local_data.rs`
909 The directories and files used for loading external file modules can be
910 influenced with the `path` attribute.
913 #[path = "thread_files"]
915 // Load the `local_data` module from `thread_files/tls.rs`
924 view_item : extern_crate_decl | use_decl ;
927 A view item manages the namespace of a module. View items do not define new
928 items, but rather, simply change other items' visibility. There are two
931 * [`extern crate` declarations](#extern-crate-declarations)
932 * [`use` declarations](#use-declarations)
934 ##### Extern crate declarations
937 extern_crate_decl : "extern" "crate" crate_name
938 crate_name: ident | ( string_lit "as" ident )
941 An _`extern crate` declaration_ specifies a dependency on an external crate.
942 The external crate is then bound into the declaring scope as the `ident`
943 provided in the `extern_crate_decl`.
945 The external crate is resolved to a specific `soname` at compile time, and a
946 runtime linkage requirement to that `soname` is passed to the linker for
947 loading at runtime. The `soname` is resolved at compile time by scanning the
948 compiler's library path and matching the optional `crateid` provided as a
949 string literal against the `crateid` attributes that were declared on the
950 external crate when it was compiled. If no `crateid` is provided, a default
951 `name` attribute is assumed, equal to the `ident` given in the
954 Three examples of `extern crate` declarations:
959 extern crate std; // equivalent to: extern crate std as std;
961 extern crate "std" as ruststd; // linking to 'std' under another name
964 ##### Use declarations
967 use_decl : "pub" ? "use" [ path "as" ident
970 path_glob : ident [ "::" [ path_glob
972 | '{' path_item [ ',' path_item ] * '}' ;
974 path_item : ident | "mod" ;
977 A _use declaration_ creates one or more local name bindings synonymous with
978 some other [path](#paths). Usually a `use` declaration is used to shorten the
979 path required to refer to a module item. These declarations may appear at the
980 top of [modules](#modules) and [blocks](#blocks).
982 > **Note**: Unlike in many languages,
983 > `use` declarations in Rust do *not* declare linkage dependency with external crates.
984 > Rather, [`extern crate` declarations](#extern-crate-declarations) declare linkage dependencies.
986 Use declarations support a number of convenient shortcuts:
988 * Rebinding the target name as a new local name, using the syntax `use p::q::r as x;`
989 * Simultaneously binding a list of paths differing only in their final element,
990 using the glob-like brace syntax `use a::b::{c,d,e,f};`
991 * Binding all paths matching a given prefix, using the asterisk wildcard syntax
993 * Simultaneously binding a list of paths differing only in their final element
994 and their immediate parent module, using the `mod` keyword, such as
995 `use a::b::{mod, c, d};`
997 An example of `use` declarations:
1000 use std::iter::range_step;
1001 use std::option::Option::{Some, None};
1002 use std::collections::hash_map::{mod, HashMap};
1005 fn bar(map1: HashMap<String, uint>, map2: hash_map::HashMap<String, uint>){}
1008 // Equivalent to 'std::iter::range_step(0u, 10u, 2u);'
1009 range_step(0u, 10u, 2u);
1011 // Equivalent to 'foo(vec![std::option::Option::Some(1.0f64),
1012 // std::option::Option::None]);'
1013 foo(vec![Some(1.0f64), None]);
1015 // Both `hash_map` and `HashMap` are in scope.
1016 let map1 = HashMap::new();
1017 let map2 = hash_map::HashMap::new();
1022 Like items, `use` declarations are private to the containing module, by
1023 default. Also like items, a `use` declaration can be public, if qualified by
1024 the `pub` keyword. Such a `use` declaration serves to _re-export_ a name. A
1025 public `use` declaration can therefore _redirect_ some public name to a
1026 different target definition: even a definition with a private canonical path,
1027 inside a different module. If a sequence of such redirections form a cycle or
1028 cannot be resolved unambiguously, they represent a compile-time error.
1030 An example of re-exporting:
1035 pub use quux::foo::{bar, baz};
1044 In this example, the module `quux` re-exports two public names defined in
1047 Also note that the paths contained in `use` items are relative to the crate
1048 root. So, in the previous example, the `use` refers to `quux::foo::{bar,
1049 baz}`, and not simply to `foo::{bar, baz}`. This also means that top-level
1050 module declarations should be at the crate root if direct usage of the declared
1051 modules within `use` items is desired. It is also possible to use `self` and
1052 `super` at the beginning of a `use` item to refer to the current and direct
1053 parent modules respectively. All rules regarding accessing declared modules in
1054 `use` declarations applies to both module declarations and `extern crate`
1057 An example of what will and will not work for `use` items:
1060 # #![allow(unused_imports)]
1061 use foo::core::iter; // good: foo is at the root of the crate
1062 use foo::baz::foobaz; // good: foo is at the root of the crate
1067 use foo::core::iter; // good: foo is at crate root
1068 // use core::iter; // bad: native is not at the crate root
1069 use self::baz::foobaz; // good: self refers to module 'foo'
1070 use foo::bar::foobar; // good: foo is at crate root
1077 use super::bar::foobar; // good: super refers to module 'foo'
1087 A _function item_ defines a sequence of [statements](#statements) and an
1088 optional final [expression](#expressions), along with a name and a set of
1089 parameters. Functions are declared with the keyword `fn`. Functions declare a
1090 set of *input* [*slots*](#memory-slots) as parameters, through which the caller
1091 passes arguments into the function, and an *output* [*slot*](#memory-slots)
1092 through which the function passes results back to the caller.
1094 A function may also be copied into a first-class *value*, in which case the
1095 value has the corresponding [*function type*](#function-types), and can be used
1096 otherwise exactly as a function item (with a minor additional cost of calling
1097 the function indirectly).
1099 Every control path in a function logically ends with a `return` expression or a
1100 diverging expression. If the outermost block of a function has a
1101 value-producing expression in its final-expression position, that expression is
1102 interpreted as an implicit `return` expression applied to the final-expression.
1104 An example of a function:
1107 fn add(x: int, y: int) -> int {
1112 As with `let` bindings, function arguments are irrefutable patterns, so any
1113 pattern that is valid in a let binding is also valid as an argument.
1116 fn first((value, _): (int, int)) -> int { value }
1120 #### Generic functions
1122 A _generic function_ allows one or more _parameterized types_ to appear in its
1123 signature. Each type parameter must be explicitly declared, in an
1124 angle-bracket-enclosed, comma-separated list following the function name.
1127 fn iter<T>(seq: &[T], f: |T|) {
1128 for elt in seq.iter() { f(elt); }
1130 fn map<T, U>(seq: &[T], f: |T| -> U) -> Vec<U> {
1131 let mut acc = vec![];
1132 for elt in seq.iter() { acc.push(f(elt)); }
1137 Inside the function signature and body, the name of the type parameter can be
1138 used as a type name.
1140 When a generic function is referenced, its type is instantiated based on the
1141 context of the reference. For example, calling the `iter` function defined
1142 above on `[1, 2]` will instantiate type parameter `T` with `int`, and require
1143 the closure parameter to have type `fn(int)`.
1145 The type parameters can also be explicitly supplied in a trailing
1146 [path](#paths) component after the function name. This might be necessary if
1147 there is not sufficient context to determine the type parameters. For example,
1148 `mem::size_of::<u32>() == 4`.
1150 Since a parameter type is opaque to the generic function, the set of operations
1151 that can be performed on it is limited. Values of parameter type can only be
1155 fn id<T>(x: T) -> T { x }
1158 Similarly, [trait](#traits) bounds can be specified for type parameters to
1159 allow methods with that trait to be called on values of that type.
1163 Unsafe operations are those that potentially violate the memory-safety
1164 guarantees of Rust's static semantics.
1166 The following language level features cannot be used in the safe subset of
1169 - Dereferencing a [raw pointer](#pointer-types).
1170 - Reading or writing a [mutable static variable](#mutable-statics).
1171 - Calling an unsafe function (including an intrinsic or foreign function).
1173 ##### Unsafe functions
1175 Unsafe functions are functions that are not safe in all contexts and/or for all
1176 possible inputs. Such a function must be prefixed with the keyword `unsafe` and
1177 can only be called from an `unsafe` block or another `unsafe` function.
1181 A block of code can be prefixed with the `unsafe` keyword, to permit calling
1182 `unsafe` functions or dereferencing raw pointers within a safe function.
1184 When a programmer has sufficient conviction that a sequence of potentially
1185 unsafe operations is actually safe, they can encapsulate that sequence (taken
1186 as a whole) within an `unsafe` block. The compiler will consider uses of such
1187 code safe, in the surrounding context.
1189 Unsafe blocks are used to wrap foreign libraries, make direct use of hardware
1190 or implement features not directly present in the language. For example, Rust
1191 provides the language features necessary to implement memory-safe concurrency
1192 in the language but the implementation of threads and message passing is in the
1195 Rust's type system is a conservative approximation of the dynamic safety
1196 requirements, so in some cases there is a performance cost to using safe code.
1197 For example, a doubly-linked list is not a tree structure and can only be
1198 represented with reference-counted pointers in safe code. By using `unsafe`
1199 blocks to represent the reverse links as raw pointers, it can be implemented
1202 ##### Behavior considered undefined
1204 The following is a list of behavior which is forbidden in all Rust code,
1205 including within `unsafe` blocks and `unsafe` functions. Type checking provides
1206 the guarantee that these issues are never caused by safe code.
1209 * Dereferencing a null/dangling raw pointer
1210 * Mutating an immutable value/reference without `UnsafeCell`
1211 * Reads of [undef](http://llvm.org/docs/LangRef.html#undefined-values)
1212 (uninitialized) memory
1213 * Breaking the [pointer aliasing
1214 rules](http://llvm.org/docs/LangRef.html#pointer-aliasing-rules)
1215 with raw pointers (a subset of the rules used by C)
1216 * Invoking undefined behavior via compiler intrinsics:
1217 * Indexing outside of the bounds of an object with `std::ptr::offset`
1218 (`offset` intrinsic), with
1219 the exception of one byte past the end which is permitted.
1220 * Using `std::ptr::copy_nonoverlapping_memory` (`memcpy32`/`memcpy64`
1221 intrinsics) on overlapping buffers
1222 * Invalid values in primitive types, even in private fields/locals:
1223 * Dangling/null references or boxes
1224 * A value other than `false` (0) or `true` (1) in a `bool`
1225 * A discriminant in an `enum` not included in the type definition
1226 * A value in a `char` which is a surrogate or above `char::MAX`
1227 * Non-UTF-8 byte sequences in a `str`
1228 * Unwinding into Rust from foreign code or unwinding from Rust into foreign
1229 code. Rust's failure system is not compatible with exception handling in
1230 other languages. Unwinding must be caught and handled at FFI boundaries.
1232 ##### Behaviour not considered unsafe
1234 This is a list of behaviour not considered *unsafe* in Rust terms, but that may
1238 * Reading data from private fields (`std::repr`)
1239 * Leaks due to reference count cycles, even in the global heap
1240 * Exiting without calling destructors
1242 * Accessing/modifying the file system
1243 * Unsigned integer overflow (well-defined as wrapping)
1244 * Signed integer overflow (well-defined as two's complement representation
1247 #### Diverging functions
1249 A special kind of function can be declared with a `!` character where the
1250 output slot type would normally be. For example:
1253 fn my_err(s: &str) -> ! {
1259 We call such functions "diverging" because they never return a value to the
1260 caller. Every control path in a diverging function must end with a `panic!()` or
1261 a call to another diverging function on every control path. The `!` annotation
1262 does *not* denote a type. Rather, the result type of a diverging function is a
1263 special type called ⊥ ("bottom") that unifies with any type. Rust has no
1266 It might be necessary to declare a diverging function because as mentioned
1267 previously, the typechecker checks that every control path in a function ends
1268 with a [`return`](#return-expressions) or diverging expression. So, if `my_err`
1269 were declared without the `!` annotation, the following code would not
1273 # fn my_err(s: &str) -> ! { panic!() }
1275 fn f(i: int) -> int {
1280 my_err("Bad number!");
1285 This will not compile without the `!` annotation on `my_err`, since the `else`
1286 branch of the conditional in `f` does not return an `int`, as required by the
1287 signature of `f`. Adding the `!` annotation to `my_err` informs the
1288 typechecker that, should control ever enter `my_err`, no further type judgments
1289 about `f` need to hold, since control will never resume in any context that
1290 relies on those judgments. Thus the return type on `f` only needs to reflect
1291 the `if` branch of the conditional.
1293 #### Extern functions
1295 Extern functions are part of Rust's foreign function interface, providing the
1296 opposite functionality to [external blocks](#external-blocks). Whereas
1297 external blocks allow Rust code to call foreign code, extern functions with
1298 bodies defined in Rust code _can be called by foreign code_. They are defined
1299 in the same way as any other Rust function, except that they have the `extern`
1303 // Declares an extern fn, the ABI defaults to "C"
1304 extern fn new_int() -> int { 0 }
1306 // Declares an extern fn with "stdcall" ABI
1307 extern "stdcall" fn new_int_stdcall() -> int { 0 }
1310 Unlike normal functions, extern fns have an `extern "ABI" fn()`. This is the
1311 same type as the functions declared in an extern block.
1314 # extern fn new_int() -> int { 0 }
1315 let fptr: extern "C" fn() -> int = new_int;
1318 Extern functions may be called directly from Rust code as Rust uses large,
1319 contiguous stack segments like C.
1323 A _type alias_ defines a new name for an existing [type](#types). Type
1324 aliases are declared with the keyword `type`. Every value has a single,
1325 specific type; the type-specified aspects of a value include:
1327 * Whether the value is composed of sub-values or is indivisible.
1328 * Whether the value represents textual or numerical information.
1329 * Whether the value represents integral or floating-point information.
1330 * The sequence of memory operations required to access the value.
1331 * The [kind](#type-kinds) of the type.
1333 For example, the type `(u8, u8)` defines the set of immutable values that are
1334 composite pairs, each containing two unsigned 8-bit integers accessed by
1335 pattern-matching and laid out in memory with the `x` component preceding the
1339 type Point = (u8, u8);
1340 let p: Point = (41, 68);
1345 A _structure_ is a nominal [structure type](#structure-types) defined with the
1348 An example of a `struct` item and its use:
1351 struct Point {x: int, y: int}
1352 let p = Point {x: 10, y: 11};
1356 A _tuple structure_ is a nominal [tuple type](#tuple-types), also defined with
1357 the keyword `struct`. For example:
1360 struct Point(int, int);
1361 let p = Point(10, 11);
1362 let px: int = match p { Point(x, _) => x };
1365 A _unit-like struct_ is a structure without any fields, defined by leaving off
1366 the list of fields entirely. Such types will have a single value, just like
1367 the [unit value `()`](#unit-and-boolean-literals) of the unit type. For
1372 let c = [Cookie, Cookie, Cookie, Cookie];
1375 The precise memory layout of a structure is not specified. One can specify a
1376 particular layout using the [`repr` attribute](#ffi-attributes).
1380 An _enumeration_ is a simultaneous definition of a nominal [enumerated
1381 type](#enumerated-types) as well as a set of *constructors*, that can be used
1382 to create or pattern-match values of the corresponding enumerated type.
1384 Enumerations are declared with the keyword `enum`.
1386 An example of an `enum` item and its use:
1394 let mut a: Animal = Animal::Dog;
1398 Enumeration constructors can have either named or unnamed fields:
1401 # #![feature(struct_variant)]
1405 Cat { name: String, weight: f64 }
1408 let mut a: Animal = Animal::Dog("Cocoa".to_string(), 37.2);
1409 a = Animal::Cat { name: "Spotty".to_string(), weight: 2.7 };
1413 In this example, `Cat` is a _struct-like enum variant_,
1414 whereas `Dog` is simply called an enum variant.
1419 const_item : "const" ident ':' type '=' expr ';' ;
1422 A *constant item* is a named _constant value_ which is not associated with a
1423 specific memory location in the program. Constants are essentially inlined
1424 wherever they are used, meaning that they are copied directly into the relevant
1425 context when used. References to the same constant are not necessarily
1426 guaranteed to refer to the same memory address.
1428 Constant values must not have destructors, and otherwise permit most forms of
1429 data. Constants may refer to the address of other constants, in which case the
1430 address will have the `static` lifetime. The compiler is, however, still at
1431 liberty to translate the constant many times, so the address referred to may not
1434 Constants must be explicitly typed. The type may be `bool`, `char`, a number, or
1435 a type derived from those primitive types. The derived types are references with
1436 the `static` lifetime, fixed-size arrays, tuples, enum variants, and structs.
1439 const BIT1: uint = 1 << 0;
1440 const BIT2: uint = 1 << 1;
1442 const BITS: [uint; 2] = [BIT1, BIT2];
1443 const STRING: &'static str = "bitstring";
1445 struct BitsNStrings<'a> {
1450 const BITS_N_STRINGS: BitsNStrings<'static> = BitsNStrings {
1459 static_item : "static" ident ':' type '=' expr ';' ;
1462 A *static item* is similar to a *constant*, except that it represents a precise
1463 memory location in the program. A static is never "inlined" at the usage site,
1464 and all references to it refer to the same memory location. Static items have
1465 the `static` lifetime, which outlives all other lifetimes in a Rust program.
1466 Static items may be placed in read-only memory if they do not contain any
1467 interior mutability.
1469 Statics may contain interior mutability through the `UnsafeCell` language item.
1470 All access to a static is safe, but there are a number of restrictions on
1473 * Statics may not contain any destructors.
1474 * The types of static values must ascribe to `Sync` to allow threadsafe access.
1475 * Statics may not refer to other statics by value, only by reference.
1476 * Constants cannot refer to statics.
1478 Constants should in general be preferred over statics, unless large amounts of
1479 data are being stored, or single-address and mutability properties are required.
1482 use std::sync::atomic::{AtomicUint, Ordering, ATOMIC_UINT_INIT};;
1484 // Note that ATOMIC_UINT_INIT is a *const*, but it may be used to initialize a
1485 // static. This static can be modified, so it is not placed in read-only memory.
1486 static COUNTER: AtomicUint = ATOMIC_UINT_INIT;
1488 // This table is a candidate to be placed in read-only memory.
1489 static TABLE: &'static [uint] = &[1, 2, 3, /* ... */];
1491 for slot in TABLE.iter() {
1492 println!("{}", slot);
1494 COUNTER.fetch_add(1, Ordering::SeqCst);
1497 #### Mutable statics
1499 If a static item is declared with the `mut` keyword, then it is allowed to
1500 be modified by the program. One of Rust's goals is to make concurrency bugs
1501 hard to run into, and this is obviously a very large source of race conditions
1502 or other bugs. For this reason, an `unsafe` block is required when either
1503 reading or writing a mutable static variable. Care should be taken to ensure
1504 that modifications to a mutable static are safe with respect to other threads
1505 running in the same process.
1507 Mutable statics are still very useful, however. They can be used with C
1508 libraries and can also be bound from C libraries (in an `extern` block).
1511 # fn atomic_add(_: &mut uint, _: uint) -> uint { 2 }
1513 static mut LEVELS: uint = 0;
1515 // This violates the idea of no shared state, and this doesn't internally
1516 // protect against races, so this function is `unsafe`
1517 unsafe fn bump_levels_unsafe1() -> uint {
1523 // Assuming that we have an atomic_add function which returns the old value,
1524 // this function is "safe" but the meaning of the return value may not be what
1525 // callers expect, so it's still marked as `unsafe`
1526 unsafe fn bump_levels_unsafe2() -> uint {
1527 return atomic_add(&mut LEVELS, 1);
1531 Mutable statics have the same restrictions as normal statics, except that the
1532 type of the value is not required to ascribe to `Sync`.
1536 A _trait_ describes a set of method types.
1538 Traits can include default implementations of methods, written in terms of some
1539 unknown [`self` type](#self-types); the `self` type may either be completely
1540 unspecified, or constrained by some other trait.
1542 Traits are implemented for specific types through separate
1543 [implementations](#implementations).
1546 # type Surface = int;
1547 # type BoundingBox = int;
1549 fn draw(&self, Surface);
1550 fn bounding_box(&self) -> BoundingBox;
1554 This defines a trait with two methods. All values that have
1555 [implementations](#implementations) of this trait in scope can have their
1556 `draw` and `bounding_box` methods called, using `value.bounding_box()`
1557 [syntax](#method-call-expressions).
1559 Type parameters can be specified for a trait to make it generic. These appear
1560 after the trait name, using the same syntax used in [generic
1561 functions](#generic-functions).
1565 fn len(&self) -> uint;
1566 fn elt_at(&self, n: uint) -> T;
1567 fn iter<F>(&self, F) where F: Fn(T);
1571 Generic functions may use traits as _bounds_ on their type parameters. This
1572 will have two effects: only types that have the trait may instantiate the
1573 parameter, and within the generic function, the methods of the trait can be
1574 called on values that have the parameter's type. For example:
1577 # type Surface = int;
1578 # trait Shape { fn draw(&self, Surface); }
1579 fn draw_twice<T: Shape>(surface: Surface, sh: T) {
1585 Traits also define an [object type](#object-types) with the same name as the
1586 trait. Values of this type are created by [casting](#type-cast-expressions)
1587 pointer values (pointing to a type for which an implementation of the given
1588 trait is in scope) to pointers to the trait name, used as a type.
1591 # use std::boxed::Box;
1593 # impl Shape for int { }
1594 # let mycircle = 0i;
1595 let myshape: Box<Shape> = Box::new(mycircle) as Box<Shape>;
1598 The resulting value is a box containing the value that was cast, along with
1599 information that identifies the methods of the implementation that was used.
1600 Values with a trait type can have [methods called](#method-call-expressions) on
1601 them, for any method in the trait, and can be used to instantiate type
1602 parameters that are bounded by the trait.
1604 Trait methods may be static, which means that they lack a `self` argument.
1605 This means that they can only be called with function call syntax (`f(x)`) and
1606 not method call syntax (`obj.f()`). The way to refer to the name of a static
1607 method is to qualify it with the trait name, treating the trait name like a
1608 module. For example:
1612 fn from_int(n: int) -> Self;
1615 fn from_int(n: int) -> f64 { n as f64 }
1617 let x: f64 = Num::from_int(42);
1620 Traits may inherit from other traits. For example, in
1623 trait Shape { fn area() -> f64; }
1624 trait Circle : Shape { fn radius() -> f64; }
1627 the syntax `Circle : Shape` means that types that implement `Circle` must also
1628 have an implementation for `Shape`. Multiple supertraits are separated by `+`,
1629 `trait Circle : Shape + PartialEq { }`. In an implementation of `Circle` for a
1630 given type `T`, methods can refer to `Shape` methods, since the typechecker
1631 checks that any type with an implementation of `Circle` also has an
1632 implementation of `Shape`.
1634 In type-parameterized functions, methods of the supertrait may be called on
1635 values of subtrait-bound type parameters. Referring to the previous example of
1636 `trait Circle : Shape`:
1639 # trait Shape { fn area(&self) -> f64; }
1640 # trait Circle : Shape { fn radius(&self) -> f64; }
1641 fn radius_times_area<T: Circle>(c: T) -> f64 {
1642 // `c` is both a Circle and a Shape
1643 c.radius() * c.area()
1647 Likewise, supertrait methods may also be called on trait objects.
1650 # use std::boxed::Box;
1651 # trait Shape { fn area(&self) -> f64; }
1652 # trait Circle : Shape { fn radius(&self) -> f64; }
1653 # impl Shape for int { fn area(&self) -> f64 { 0.0 } }
1654 # impl Circle for int { fn radius(&self) -> f64 { 0.0 } }
1656 let mycircle = Box::new(mycircle) as Box<Circle>;
1657 let nonsense = mycircle.radius() * mycircle.area();
1662 An _implementation_ is an item that implements a [trait](#traits) for a
1665 Implementations are defined with the keyword `impl`.
1668 # struct Point {x: f64, y: f64};
1669 # impl Copy for Point {}
1670 # type Surface = int;
1671 # struct BoundingBox {x: f64, y: f64, width: f64, height: f64};
1672 # trait Shape { fn draw(&self, Surface); fn bounding_box(&self) -> BoundingBox; }
1673 # fn do_draw_circle(s: Surface, c: Circle) { }
1679 impl Copy for Circle {}
1681 impl Shape for Circle {
1682 fn draw(&self, s: Surface) { do_draw_circle(s, *self); }
1683 fn bounding_box(&self) -> BoundingBox {
1684 let r = self.radius;
1685 BoundingBox{x: self.center.x - r, y: self.center.y - r,
1686 width: 2.0 * r, height: 2.0 * r}
1691 It is possible to define an implementation without referring to a trait. The
1692 methods in such an implementation can only be used as direct calls on the
1693 values of the type that the implementation targets. In such an implementation,
1694 the trait type and `for` after `impl` are omitted. Such implementations are
1695 limited to nominal types (enums, structs), and the implementation must appear
1696 in the same module or a sub-module as the `self` type:
1699 struct Point {x: int, y: int}
1703 println!("Point is at ({}, {})", self.x, self.y);
1707 let my_point = Point {x: 10, y:11};
1711 When a trait _is_ specified in an `impl`, all methods declared as part of the
1712 trait must be implemented, with matching types and type parameter counts.
1714 An implementation can take type parameters, which can be different from the
1715 type parameters taken by the trait it implements. Implementation parameters
1716 are written after the `impl` keyword.
1720 impl<T> Seq<T> for Vec<T> {
1723 impl Seq<bool> for u32 {
1724 /* Treat the integer as a sequence of bits */
1731 extern_block_item : "extern" '{' extern_block '}' ;
1732 extern_block : [ foreign_fn ] * ;
1735 External blocks form the basis for Rust's foreign function interface.
1736 Declarations in an external block describe symbols in external, non-Rust
1739 Functions within external blocks are declared in the same way as other Rust
1740 functions, with the exception that they may not have a body and are instead
1741 terminated by a semicolon.
1745 use libc::{c_char, FILE};
1748 fn fopen(filename: *const c_char, mode: *const c_char) -> *mut FILE;
1753 Functions within external blocks may be called by Rust code, just like
1754 functions defined in Rust. The Rust compiler automatically translates between
1755 the Rust ABI and the foreign ABI.
1757 A number of [attributes](#attributes) control the behavior of external blocks.
1759 By default external blocks assume that the library they are calling uses the
1760 standard C "cdecl" ABI. Other ABIs may be specified using an `abi` string, as
1764 // Interface to the Windows API
1765 extern "stdcall" { }
1768 The `link` attribute allows the name of the library to be specified. When
1769 specified the compiler will attempt to link against the native library of the
1773 #[link(name = "crypto")]
1777 The type of a function declared in an extern block is `extern "abi" fn(A1, ...,
1778 An) -> R`, where `A1...An` are the declared types of its arguments and `R` is
1779 the declared return type.
1781 ## Visibility and Privacy
1783 These two terms are often used interchangeably, and what they are attempting to
1784 convey is the answer to the question "Can this item be used at this location?"
1786 Rust's name resolution operates on a global hierarchy of namespaces. Each level
1787 in the hierarchy can be thought of as some item. The items are one of those
1788 mentioned above, but also include external crates. Declaring or defining a new
1789 module can be thought of as inserting a new tree into the hierarchy at the
1790 location of the definition.
1792 To control whether interfaces can be used across modules, Rust checks each use
1793 of an item to see whether it should be allowed or not. This is where privacy
1794 warnings are generated, or otherwise "you used a private item of another module
1795 and weren't allowed to."
1797 By default, everything in Rust is *private*, with one exception. Enum variants
1798 in a `pub` enum are also public by default. You are allowed to alter this
1799 default visibility with the `priv` keyword. When an item is declared as `pub`,
1800 it can be thought of as being accessible to the outside world. For example:
1803 # #![allow(missing_copy_implementations)]
1805 // Declare a private struct
1808 // Declare a public struct with a private field
1813 // Declare a public enum with two public variants
1815 PubliclyAccessibleState,
1816 PubliclyAccessibleState2,
1820 With the notion of an item being either public or private, Rust allows item
1821 accesses in two cases:
1823 1. If an item is public, then it can be used externally through any of its
1825 2. If an item is private, it may be accessed by the current module and its
1828 These two cases are surprisingly powerful for creating module hierarchies
1829 exposing public APIs while hiding internal implementation details. To help
1830 explain, here's a few use cases and what they would entail:
1832 * A library developer needs to expose functionality to crates which link
1833 against their library. As a consequence of the first case, this means that
1834 anything which is usable externally must be `pub` from the root down to the
1835 destination item. Any private item in the chain will disallow external
1838 * A crate needs a global available "helper module" to itself, but it doesn't
1839 want to expose the helper module as a public API. To accomplish this, the
1840 root of the crate's hierarchy would have a private module which then
1841 internally has a "public api". Because the entire crate is a descendant of
1842 the root, then the entire local crate can access this private module through
1845 * When writing unit tests for a module, it's often a common idiom to have an
1846 immediate child of the module to-be-tested named `mod test`. This module
1847 could access any items of the parent module through the second case, meaning
1848 that internal implementation details could also be seamlessly tested from the
1851 In the second case, it mentions that a private item "can be accessed" by the
1852 current module and its descendants, but the exact meaning of accessing an item
1853 depends on what the item is. Accessing a module, for example, would mean
1854 looking inside of it (to import more items). On the other hand, accessing a
1855 function would mean that it is invoked. Additionally, path expressions and
1856 import statements are considered to access an item in the sense that the
1857 import/expression is only valid if the destination is in the current visibility
1860 Here's an example of a program which exemplifies the three cases outlined
1864 // This module is private, meaning that no external crate can access this
1865 // module. Because it is private at the root of this current crate, however, any
1866 // module in the crate may access any publicly visible item in this module.
1867 mod crate_helper_module {
1869 // This function can be used by anything in the current crate
1870 pub fn crate_helper() {}
1872 // This function *cannot* be used by anything else in the crate. It is not
1873 // publicly visible outside of the `crate_helper_module`, so only this
1874 // current module and its descendants may access it.
1875 fn implementation_detail() {}
1878 // This function is "public to the root" meaning that it's available to external
1879 // crates linking against this one.
1880 pub fn public_api() {}
1882 // Similarly to 'public_api', this module is public so external crates may look
1885 use crate_helper_module;
1887 pub fn my_method() {
1888 // Any item in the local crate may invoke the helper module's public
1889 // interface through a combination of the two rules above.
1890 crate_helper_module::crate_helper();
1893 // This function is hidden to any module which is not a descendant of
1895 fn my_implementation() {}
1901 fn test_my_implementation() {
1902 // Because this module is a descendant of `submodule`, it's allowed
1903 // to access private items inside of `submodule` without a privacy
1905 super::my_implementation();
1913 For a rust program to pass the privacy checking pass, all paths must be valid
1914 accesses given the two rules above. This includes all use statements,
1915 expressions, types, etc.
1917 ### Re-exporting and Visibility
1919 Rust allows publicly re-exporting items through a `pub use` directive. Because
1920 this is a public directive, this allows the item to be used in the current
1921 module through the rules above. It essentially allows public access into the
1922 re-exported item. For example, this program is valid:
1925 pub use self::implementation as api;
1927 mod implementation {
1934 This means that any external crate referencing `implementation::f` would
1935 receive a privacy violation, while the path `api::f` would be allowed.
1937 When re-exporting a private item, it can be thought of as allowing the "privacy
1938 chain" being short-circuited through the reexport instead of passing through
1939 the namespace hierarchy as it normally would.
1944 attribute : "#!" ? '[' meta_item ']' ;
1945 meta_item : ident [ '=' literal
1946 | '(' meta_seq ')' ] ? ;
1947 meta_seq : meta_item [ ',' meta_seq ] ? ;
1950 Any item declaration may have an _attribute_ applied to it. Attributes in Rust
1951 are modeled on Attributes in ECMA-335, with the syntax coming from ECMA-334
1952 (C#). An attribute is a general, free-form metadatum that is interpreted
1953 according to name, convention, and language and compiler version. Attributes
1954 may appear as any of:
1956 * A single identifier, the attribute name
1957 * An identifier followed by the equals sign '=' and a literal, providing a
1959 * An identifier followed by a parenthesized list of sub-attribute arguments
1961 Attributes with a bang ("!") after the hash ("#") apply to the item that the
1962 attribute is declared within. Attributes that do not have a bang after the hash
1963 apply to the item that follows the attribute.
1965 An example of attributes:
1968 // General metadata applied to the enclosing module or crate.
1969 #![crate_type = "lib"]
1971 // A function marked as a unit test
1977 // A conditionally-compiled module
1978 #[cfg(target_os="linux")]
1983 // A lint attribute used to suppress a warning/error
1984 #[allow(non_camel_case_types)]
1988 > **Note:** At some point in the future, the compiler will distinguish between
1989 > language-reserved and user-available attributes. Until then, there is
1990 > effectively no difference between an attribute handled by a loadable syntax
1991 > extension and the compiler.
1993 ### Crate-only attributes
1995 - `crate_name` - specify the this crate's crate name.
1996 - `crate_type` - see [linkage](#linkage).
1997 - `feature` - see [compiler features](#compiler-features).
1998 - `no_builtins` - disable optimizing certain code patterns to invocations of
1999 library functions that are assumed to exist
2000 - `no_main` - disable emitting the `main` symbol. Useful when some other
2001 object being linked to defines `main`.
2002 - `no_start` - disable linking to the `native` crate, which specifies the
2003 "start" language item.
2004 - `no_std` - disable linking to the `std` crate.
2006 ### Module-only attributes
2008 - `no_implicit_prelude` - disable injecting `use std::prelude::*` in this
2010 - `path` - specifies the file to load the module from. `#[path="foo.rs"] mod
2011 bar;` is equivalent to `mod bar { /* contents of foo.rs */ }`. The path is
2012 taken relative to the directory that the current module is in.
2014 ### Function-only attributes
2016 - `main` - indicates that this function should be passed to the entry point,
2017 rather than the function in the crate root named `main`.
2018 - `plugin_registrar` - mark this function as the registration point for
2019 [compiler plugins][plugin], such as loadable syntax extensions.
2020 - `start` - indicates that this function should be used as the entry point,
2021 overriding the "start" language item. See the "start" [language
2022 item](#language-items) for more details.
2023 - `test` - indicates that this function is a test function, to only be compiled
2024 in case of `--test`.
2026 ### Static-only attributes
2028 - `thread_local` - on a `static mut`, this signals that the value of this
2029 static may change depending on the current thread. The exact consequences of
2030 this are implementation-defined.
2034 On an `extern` block, the following attributes are interpreted:
2036 - `link_args` - specify arguments to the linker, rather than just the library
2037 name and type. This is feature gated and the exact behavior is
2038 implementation-defined (due to variety of linker invocation syntax).
2039 - `link` - indicate that a native library should be linked to for the
2040 declarations in this block to be linked correctly. `link` supports an optional `kind`
2041 key with three possible values: `dylib`, `static`, and `framework`. See [external blocks](#external-blocks) for more about external blocks. Two
2042 examples: `#[link(name = "readline")]` and
2043 `#[link(name = "CoreFoundation", kind = "framework")]`.
2045 On declarations inside an `extern` block, the following attributes are
2048 - `link_name` - the name of the symbol that this function or static should be
2050 - `linkage` - on a static, this specifies the [linkage
2051 type](http://llvm.org/docs/LangRef.html#linkage-types).
2055 - `repr` - on C-like enums, this sets the underlying type used for
2056 representation. Takes one argument, which is the primitive
2057 type this enum should be represented for, or `C`, which specifies that it
2058 should be the default `enum` size of the C ABI for that platform. Note that
2059 enum representation in C is undefined, and this may be incorrect when the C
2060 code is compiled with certain flags.
2064 - `repr` - specifies the representation to use for this struct. Takes a list
2065 of options. The currently accepted ones are `C` and `packed`, which may be
2066 combined. `C` will use a C ABI compatible struct layout, and `packed` will
2067 remove any padding between fields (note that this is very fragile and may
2068 break platforms which require aligned access).
2070 ### Macro- and plugin-related attributes
2072 - `macro_use` on a `mod` — macros defined in this module will be visible in the
2073 module's parent, after this module has been included.
2075 - `macro_use` on an `extern crate` — load macros from this crate. An optional
2076 list of names `#[macro_use(foo, bar)]` restricts the import to just those
2077 macros named. The `extern crate` must appear at the crate root, not inside
2078 `mod`, which ensures proper function of the [`$crate` macro
2079 variable](book/macros.html#the-variable-$crate).
2081 - `macro_reexport` on an `extern crate` — re-export the named macros.
2083 - `macro_export` - export a macro for cross-crate usage.
2085 - `plugin` on an `extern crate` — load this crate as a [compiler
2086 plugin][plugin]. The `plugin` feature gate is required. Any arguments to
2087 the attribute, e.g. `#[plugin=...]` or `#[plugin(...)]`, are provided to the
2090 - `no_link` on an `extern crate` — even if we load this crate for macros or
2091 compiler plugins, don't link it into the output.
2093 See the [macros section of the
2094 book](book/macros.html#scoping-and-macro-import/export) for more information on
2098 ### Miscellaneous attributes
2100 - `export_name` - on statics and functions, this determines the name of the
2102 - `link_section` - on statics and functions, this specifies the section of the
2103 object file that this item's contents will be placed into.
2104 - `no_mangle` - on any item, do not apply the standard name mangling. Set the
2105 symbol for this item to its identifier.
2106 - `packed` - on structs or enums, eliminate any padding that would be used to
2108 - `simd` - on certain tuple structs, derive the arithmetic operators, which
2109 lower to the target's SIMD instructions, if any; the `simd` feature gate
2110 is necessary to use this attribute.
2111 - `static_assert` - on statics whose type is `bool`, terminates compilation
2112 with an error if it is not initialized to `true`.
2113 - `unsafe_destructor` - allow implementations of the "drop" language item
2114 where the type it is implemented for does not implement the "send" language
2115 item; the `unsafe_destructor` feature gate is needed to use this attribute
2116 - `unsafe_no_drop_flag` - on structs, remove the flag that prevents
2117 destructors from being run twice. Destructors might be run multiple times on
2118 the same object with this attribute.
2119 - `doc` - Doc comments such as `/// foo` are equivalent to `#[doc = "foo"]`.
2120 - `rustc_on_unimplemented` - Write a custom note to be shown along with the error
2121 when the trait is found to be unimplemented on a type.
2122 You may use format arguments like `{T}`, `{A}` to correspond to the
2123 types at the point of use corresponding to the type parameters of the
2124 trait of the same name. `{Self}` will be replaced with the type that is supposed
2125 to implement the trait but doesn't. To use this, the `on_unimplemented` feature gate
2128 ### Conditional compilation
2130 Sometimes one wants to have different compiler outputs from the same code,
2131 depending on build target, such as targeted operating system, or to enable
2134 There are two kinds of configuration options, one that is either defined or not
2135 (`#[cfg(foo)]`), and the other that contains a string that can be checked
2136 against (`#[cfg(bar = "baz")]` (currently only compiler-defined configuration
2137 options can have the latter form).
2140 // The function is only included in the build when compiling for OSX
2141 #[cfg(target_os = "macos")]
2146 // This function is only included when either foo or bar is defined
2147 #[cfg(any(foo, bar))]
2148 fn needs_foo_or_bar() {
2152 // This function is only included when compiling for a unixish OS with a 32-bit
2154 #[cfg(all(unix, target_word_size = "32"))]
2155 fn on_32bit_unix() {
2159 // This function is only included when foo is not defined
2161 fn needs_not_foo() {
2166 This illustrates some conditional compilation can be achieved using the
2167 `#[cfg(...)]` attribute. `any`, `all` and `not` can be used to assemble
2168 arbitrarily complex configurations through nesting.
2170 The following configurations must be defined by the implementation:
2172 * `target_arch = "..."`. Target CPU architecture, such as `"x86"`, `"x86_64"`
2173 `"mips"`, `"powerpc"`, `"arm"`, or `"aarch64"`.
2174 * `target_endian = "..."`. Endianness of the target CPU, either `"little"` or
2176 * `target_family = "..."`. Operating system family of the target, e. g.
2177 `"unix"` or `"windows"`. The value of this configuration option is defined
2178 as a configuration itself, like `unix` or `windows`.
2179 * `target_os = "..."`. Operating system of the target, examples include
2180 `"win32"`, `"macos"`, `"linux"`, `"android"`, `"freebsd"` or `"dragonfly"`.
2181 * `target_word_size = "..."`. Target word size in bits. This is set to `"32"`
2182 for targets with 32-bit pointers, and likewise set to `"64"` for 64-bit
2184 * `unix`. See `target_family`.
2185 * `windows`. See `target_family`.
2187 ### Lint check attributes
2189 A lint check names a potentially undesirable coding pattern, such as
2190 unreachable code or omitted documentation, for the static entity to which the
2193 For any lint check `C`:
2195 * `allow(C)` overrides the check for `C` so that violations will go
2197 * `deny(C)` signals an error after encountering a violation of `C`,
2198 * `forbid(C)` is the same as `deny(C)`, but also forbids changing the lint
2200 * `warn(C)` warns about violations of `C` but continues compilation.
2202 The lint checks supported by the compiler can be found via `rustc -W help`,
2203 along with their default settings. [Compiler
2204 plugins](book/plugin.html#lint-plugins) can provide additional lint checks.
2208 // Missing documentation is ignored here
2209 #[allow(missing_docs)]
2210 pub fn undocumented_one() -> int { 1 }
2212 // Missing documentation signals a warning here
2213 #[warn(missing_docs)]
2214 pub fn undocumented_too() -> int { 2 }
2216 // Missing documentation signals an error here
2217 #[deny(missing_docs)]
2218 pub fn undocumented_end() -> int { 3 }
2222 This example shows how one can use `allow` and `warn` to toggle a particular
2226 #[warn(missing_docs)]
2228 #[allow(missing_docs)]
2230 // Missing documentation is ignored here
2231 pub fn undocumented_one() -> int { 1 }
2233 // Missing documentation signals a warning here,
2234 // despite the allow above.
2235 #[warn(missing_docs)]
2236 pub fn undocumented_two() -> int { 2 }
2239 // Missing documentation signals a warning here
2240 pub fn undocumented_too() -> int { 3 }
2244 This example shows how one can use `forbid` to disallow uses of `allow` for
2248 #[forbid(missing_docs)]
2250 // Attempting to toggle warning signals an error here
2251 #[allow(missing_docs)]
2253 pub fn undocumented_too() -> int { 2 }
2259 Some primitive Rust operations are defined in Rust code, rather than being
2260 implemented directly in C or assembly language. The definitions of these
2261 operations have to be easy for the compiler to find. The `lang` attribute
2262 makes it possible to declare these operations. For example, the `str` module
2263 in the Rust standard library defines the string equality function:
2267 pub fn eq_slice(a: &str, b: &str) -> bool {
2272 The name `str_eq` has a special meaning to the Rust compiler, and the presence
2273 of this definition means that it will use this definition when generating calls
2274 to the string equality function.
2276 A complete list of the built-in language items follows:
2278 #### Built-in Traits
2281 : Types that do not move ownership when used by-value.
2285 : Able to be sent across thread boundaries.
2287 : Has a size known at compile time.
2289 : Able to be safely shared between threads when aliased.
2293 These language items are traits:
2296 : Elements can be added (for example, integers and floats).
2298 : Elements can be subtracted.
2300 : Elements can be multiplied.
2302 : Elements have a division operation.
2304 : Elements have a remainder operation.
2306 : Elements can be negated arithmetically.
2308 : Elements can be negated logically.
2310 : Elements have an exclusive-or operation.
2312 : Elements have a bitwise `and` operation.
2314 : Elements have a bitwise `or` operation.
2316 : Elements have a left shift operation.
2318 : Elements have a right shift operation.
2320 : Elements can be indexed.
2322 : ___Needs filling in___
2324 : Elements can be compared for equality.
2326 : Elements have a partial ordering.
2328 : `*` can be applied, yielding a reference to another type.
2330 : `*` can be applied, yielding a mutable reference to another type.
2332 These are functions:
2335 : ___Needs filling in___
2337 : ___Needs filling in___
2339 : ___Needs filling in___
2341 : Compare two strings (`&str`) for equality.
2343 : Return a new unique string
2344 containing a copy of the contents of a unique string.
2349 : The type returned by the `type_id` intrinsic.
2351 : A type whose contents can be mutated through an immutable reference.
2355 These types help drive the compiler's analysis
2358 : ___Needs filling in___
2360 : This type does not implement "copy", even if eligible.
2362 : This type does not implement "send", even if eligible.
2364 : This type does not implement "sync", even if eligible.
2366 : ___Needs filling in___
2368 : Free memory that was allocated on the exchange heap.
2370 : Allocate memory on the exchange heap.
2371 * `closure_exchange_malloc`
2372 : ___Needs filling in___
2374 : Abort the program with an error.
2375 * `fail_bounds_check`
2376 : Abort the program with a bounds check error.
2378 : Free memory that was allocated on the managed heap.
2380 : ___Needs filling in___
2382 : ___Needs filling in___
2384 : ___Needs filling in___
2385 * `contravariant_lifetime`
2386 : The lifetime parameter should be considered contravariant.
2387 * `covariant_lifetime`
2388 : The lifetime parameter should be considered covariant.
2389 * `invariant_lifetime`
2390 : The lifetime parameter should be considered invariant.
2392 : Allocate memory on the managed heap.
2394 : ___Needs filling in___
2396 : ___Needs filling in___
2398 : ___Needs filling in___
2399 * `contravariant_type`
2400 : The type parameter should be considered contravariant.
2402 : The type parameter should be considered covariant.
2404 : The type parameter should be considered invariant.
2406 : ___Needs filling in___
2408 > **Note:** This list is likely to become out of date. We should auto-generate
2409 > it from `librustc/middle/lang_items.rs`.
2411 ### Inline attributes
2413 The inline attribute is used to suggest to the compiler to perform an inline
2414 expansion and place a copy of the function or static in the caller rather than
2415 generating code to call the function or access the static where it is defined.
2417 The compiler automatically inlines functions based on internal heuristics.
2418 Incorrectly inlining functions can actually making the program slower, so it
2419 should be used with care.
2421 Immutable statics are always considered inlineable unless marked with
2422 `#[inline(never)]`. It is undefined whether two different inlineable statics
2423 have the same memory address. In other words, the compiler is free to collapse
2424 duplicate inlineable statics together.
2426 `#[inline]` and `#[inline(always)]` always causes the function to be serialized
2427 into crate metadata to allow cross-crate inlining.
2429 There are three different types of inline attributes:
2431 * `#[inline]` hints the compiler to perform an inline expansion.
2432 * `#[inline(always)]` asks the compiler to always perform an inline expansion.
2433 * `#[inline(never)]` asks the compiler to never perform an inline expansion.
2437 The `deriving` attribute allows certain traits to be automatically implemented
2438 for data structures. For example, the following will create an `impl` for the
2439 `PartialEq` and `Clone` traits for `Foo`, the type parameter `T` will be given
2440 the `PartialEq` or `Clone` constraints for the appropriate `impl`:
2443 #[deriving(PartialEq, Clone)]
2450 The generated `impl` for `PartialEq` is equivalent to
2453 # struct Foo<T> { a: int, b: T }
2454 impl<T: PartialEq> PartialEq for Foo<T> {
2455 fn eq(&self, other: &Foo<T>) -> bool {
2456 self.a == other.a && self.b == other.b
2459 fn ne(&self, other: &Foo<T>) -> bool {
2460 self.a != other.a || self.b != other.b
2465 Supported traits for `deriving` are:
2467 * Comparison traits: `PartialEq`, `Eq`, `PartialOrd`, `Ord`.
2468 * Serialization: `Encodable`, `Decodable`. These require `serialize`.
2469 * `Clone`, to create `T` from `&T` via a copy.
2470 * `Default`, to create an empty instance of a data type.
2471 * `FromPrimitive`, to create an instance from a numeric primitive.
2472 * `Hash`, to iterate over the bytes in a data type.
2473 * `Rand`, to create a random instance of a data type.
2474 * `Show`, to format a value using the `{}` formatter.
2475 * `Zero`, to create a zero instance of a numeric data type.
2479 One can indicate the stability of an API using the following attributes:
2481 * `deprecated`: This item should no longer be used, e.g. it has been
2482 replaced. No guarantee of backwards-compatibility.
2483 * `experimental`: This item was only recently introduced or is
2484 otherwise in a state of flux. It may change significantly, or even
2485 be removed. No guarantee of backwards-compatibility.
2486 * `unstable`: This item is still under development, but requires more
2487 testing to be considered stable. No guarantee of backwards-compatibility.
2488 * `stable`: This item is considered stable, and will not change
2489 significantly. Guarantee of backwards-compatibility.
2490 * `frozen`: This item is very stable, and is unlikely to
2491 change. Guarantee of backwards-compatibility.
2492 * `locked`: This item will never change unless a serious bug is
2493 found. Guarantee of backwards-compatibility.
2495 These levels are directly inspired by
2496 [Node.js' "stability index"](http://nodejs.org/api/documentation.html).
2498 Stability levels are inherited, so an item's stability attribute is the default
2499 stability for everything nested underneath it.
2501 There are lints for disallowing items marked with certain levels: `deprecated`,
2502 `experimental` and `unstable`. For now, only `deprecated` warns by default, but
2503 this will change once the standard library has been stabilized. Stability
2504 levels are meant to be promises at the crate level, so these lints only apply
2505 when referencing items from an _external_ crate, not to items defined within
2506 the current crate. Items with no stability level are considered to be unstable
2507 for the purposes of the lint. One can give an optional string that will be
2508 displayed when the lint flags the use of an item.
2510 For example, if we define one crate called `stability_levels`:
2513 #[deprecated="replaced by `best`"]
2515 // delete everything
2519 // delete fewer things
2528 then the lints will work as follows for a client crate:
2532 extern crate stability_levels;
2533 use stability_levels::{bad, better, best};
2536 bad(); // "warning: use of deprecated item: replaced by `best`"
2538 better(); // "warning: use of unmarked item"
2540 best(); // no warning
2544 > **Note:** Currently these are only checked when applied to individual
2545 > functions, structs, methods and enum variants, *not* to entire modules,
2546 > traits, impls or enums themselves.
2548 ### Compiler Features
2550 Certain aspects of Rust may be implemented in the compiler, but they're not
2551 necessarily ready for every-day use. These features are often of "prototype
2552 quality" or "almost production ready", but may not be stable enough to be
2553 considered a full-fledged language feature.
2555 For this reason, Rust recognizes a special crate-level attribute of the form:
2558 #![feature(feature1, feature2, feature3)]
2561 This directive informs the compiler that the feature list: `feature1`,
2562 `feature2`, and `feature3` should all be enabled. This is only recognized at a
2563 crate-level, not at a module-level. Without this directive, all features are
2564 considered off, and using the features will result in a compiler error.
2566 The currently implemented features of the reference compiler are:
2568 * `asm` - The `asm!` macro provides a means for inline assembly. This is often
2569 useful, but the exact syntax for this feature along with its
2570 semantics are likely to change, so this macro usage must be opted
2573 * `concat_idents` - Allows use of the `concat_idents` macro, which is in many
2574 ways insufficient for concatenating identifiers, and may be
2575 removed entirely for something more wholesome.
2577 * `default_type_params` - Allows use of default type parameters. The future of
2578 this feature is uncertain.
2580 * `intrinsics` - Allows use of the "rust-intrinsics" ABI. Compiler intrinsics
2581 are inherently unstable and no promise about them is made.
2583 * `lang_items` - Allows use of the `#[lang]` attribute. Like `intrinsics`,
2584 lang items are inherently unstable and no promise about them
2587 * `link_args` - This attribute is used to specify custom flags to the linker,
2588 but usage is strongly discouraged. The compiler's usage of the
2589 system linker is not guaranteed to continue in the future, and
2590 if the system linker is not used then specifying custom flags
2591 doesn't have much meaning.
2593 * `link_llvm_intrinsics` – Allows linking to LLVM intrinsics via
2594 `#[link_name="llvm.*"]`.
2596 * `linkage` - Allows use of the `linkage` attribute, which is not portable.
2598 * `log_syntax` - Allows use of the `log_syntax` macro attribute, which is a
2599 nasty hack that will certainly be removed.
2601 * `non_ascii_idents` - The compiler supports the use of non-ascii identifiers,
2602 but the implementation is a little rough around the
2603 edges, so this can be seen as an experimental feature
2604 for now until the specification of identifiers is fully
2607 * `once_fns` - Onceness guarantees a closure is only executed once. Defining a
2608 closure as `once` is unlikely to be supported going forward. So
2609 they are hidden behind this feature until they are to be removed.
2611 * `plugin` - Usage of [compiler plugins][plugin] for custom lints or syntax extensions.
2612 These depend on compiler internals and are subject to change.
2614 * `plugin_registrar` - Indicates that a crate provides [compiler plugins][plugin].
2616 * `quote` - Allows use of the `quote_*!` family of macros, which are
2617 implemented very poorly and will likely change significantly
2618 with a proper implementation.
2620 * `rustc_diagnostic_macros`- A mysterious feature, used in the implementation
2621 of rustc, not meant for mortals.
2623 * `simd` - Allows use of the `#[simd]` attribute, which is overly simple and
2624 not the SIMD interface we want to expose in the long term.
2626 * `struct_inherit` - Allows using struct inheritance, which is barely
2627 implemented and will probably be removed. Don't use this.
2629 * `struct_variant` - Structural enum variants (those with named fields). It is
2630 currently unknown whether this style of enum variant is as
2631 fully supported as the tuple-forms, and it's not certain
2632 that this style of variant should remain in the language.
2633 For now this style of variant is hidden behind a feature
2636 * `thread_local` - The usage of the `#[thread_local]` attribute is experimental
2637 and should be seen as unstable. This attribute is used to
2638 declare a `static` as being unique per-thread leveraging
2639 LLVM's implementation which works in concert with the kernel
2640 loader and dynamic linker. This is not necessarily available
2641 on all platforms, and usage of it is discouraged (rust
2642 focuses more on thread-local data instead of thread-local
2645 * `trace_macros` - Allows use of the `trace_macros` macro, which is a nasty
2646 hack that will certainly be removed.
2648 * `unboxed_closures` - Rust's new closure design, which is currently a work in
2649 progress feature with many known bugs.
2651 * `unsafe_destructor` - Allows use of the `#[unsafe_destructor]` attribute,
2652 which is considered wildly unsafe and will be
2653 obsoleted by language improvements.
2655 * `associated_types` - Allows type aliases in traits. Experimental.
2657 If a feature is promoted to a language feature, then all existing programs will
2658 start to receive compilation warnings about #[feature] directives which enabled
2659 the new feature (because the directive is no longer necessary). However, if a
2660 feature is decided to be removed from the language, errors will be issued (if
2661 there isn't a parser error first). The directive in this case is no longer
2662 necessary, and it's likely that existing code will break if the feature isn't
2665 If an unknown feature is found in a directive, it results in a compiler error.
2666 An unknown feature is one which has never been recognized by the compiler.
2668 # Statements and expressions
2670 Rust is _primarily_ an expression language. This means that most forms of
2671 value-producing or effect-causing evaluation are directed by the uniform syntax
2672 category of _expressions_. Each kind of expression can typically _nest_ within
2673 each other kind of expression, and rules for evaluation of expressions involve
2674 specifying both the value produced by the expression and the order in which its
2675 sub-expressions are themselves evaluated.
2677 In contrast, statements in Rust serve _mostly_ to contain and explicitly
2678 sequence expression evaluation.
2682 A _statement_ is a component of a block, which is in turn a component of an
2683 outer [expression](#expressions) or [function](#functions).
2685 Rust has two kinds of statement: [declaration
2686 statements](#declaration-statements) and [expression
2687 statements](#expression-statements).
2689 ### Declaration statements
2691 A _declaration statement_ is one that introduces one or more *names* into the
2692 enclosing statement block. The declared names may denote new slots or new
2695 #### Item declarations
2697 An _item declaration statement_ has a syntactic form identical to an
2698 [item](#items) declaration within a module. Declaring an item — a
2699 function, enumeration, structure, type, static, trait, implementation or module
2700 — locally within a statement block is simply a way of restricting its
2701 scope to a narrow region containing all of its uses; it is otherwise identical
2702 in meaning to declaring the item outside the statement block.
2704 > **Note**: there is no implicit capture of the function's dynamic environment when
2705 > declaring a function-local item.
2707 #### Slot declarations
2710 let_decl : "let" pat [':' type ] ? [ init ] ? ';' ;
2711 init : [ '=' ] expr ;
2714 A _slot declaration_ introduces a new set of slots, given by a pattern. The
2715 pattern may be followed by a type annotation, and/or an initializer expression.
2716 When no type annotation is given, the compiler will infer the type, or signal
2717 an error if insufficient type information is available for definite inference.
2718 Any slots introduced by a slot declaration are visible from the point of
2719 declaration until the end of the enclosing block scope.
2721 ### Expression statements
2723 An _expression statement_ is one that evaluates an [expression](#expressions)
2724 and ignores its result. The type of an expression statement `e;` is always
2725 `()`, regardless of the type of `e`. As a rule, an expression statement's
2726 purpose is to trigger the effects of evaluating its expression.
2730 An expression may have two roles: it always produces a *value*, and it may have
2731 *effects* (otherwise known as "side effects"). An expression *evaluates to* a
2732 value, and has effects during *evaluation*. Many expressions contain
2733 sub-expressions (operands). The meaning of each kind of expression dictates
2736 * Whether or not to evaluate the sub-expressions when evaluating the expression
2737 * The order in which to evaluate the sub-expressions
2738 * How to combine the sub-expressions' values to obtain the value of the expression
2740 In this way, the structure of expressions dictates the structure of execution.
2741 Blocks are just another kind of expression, so blocks, statements, expressions,
2742 and blocks again can recursively nest inside each other to an arbitrary depth.
2744 #### Lvalues, rvalues and temporaries
2746 Expressions are divided into two main categories: _lvalues_ and _rvalues_.
2747 Likewise within each expression, sub-expressions may occur in _lvalue context_
2748 or _rvalue context_. The evaluation of an expression depends both on its own
2749 category and the context it occurs within.
2751 An lvalue is an expression that represents a memory location. These expressions
2752 are [paths](#path-expressions) (which refer to local variables, function and
2753 method arguments, or static variables), dereferences (`*expr`), [indexing
2754 expressions](#index-expressions) (`expr[expr]`), and [field
2755 references](#field-expressions) (`expr.f`). All other expressions are rvalues.
2757 The left operand of an [assignment](#assignment-expressions) or
2758 [compound-assignment](#compound-assignment-expressions) expression is an lvalue
2759 context, as is the single operand of a unary
2760 [borrow](#unary-operator-expressions). All other expression contexts are
2763 When an lvalue is evaluated in an _lvalue context_, it denotes a memory
2764 location; when evaluated in an _rvalue context_, it denotes the value held _in_
2765 that memory location.
2767 When an rvalue is used in an lvalue context, a temporary un-named lvalue is
2768 created and used instead. A temporary's lifetime equals the largest lifetime
2769 of any reference that points to it.
2771 #### Moved and copied types
2773 When a [local variable](#memory-slots) is used as an
2774 [rvalue](#lvalues,-rvalues-and-temporaries) the variable will either be moved
2775 or copied, depending on its type. For types that contain [owning
2776 pointers](#pointer-types) or values that implement the special trait `Drop`,
2777 the variable is moved. All other types are copied.
2779 ### Literal expressions
2781 A _literal expression_ consists of one of the [literal](#literals) forms
2782 described earlier. It directly describes a number, character, string, boolean
2783 value, or the unit value.
2787 "hello"; // string type
2788 '5'; // character type
2792 ### Path expressions
2794 A [path](#paths) used as an expression context denotes either a local variable
2795 or an item. Path expressions are [lvalues](#lvalues,-rvalues-and-temporaries).
2797 ### Tuple expressions
2799 Tuples are written by enclosing zero or more comma-separated expressions in
2800 parentheses. They are used to create [tuple-typed](#tuple-types) values.
2808 ### Unit expressions
2810 The expression `()` denotes the _unit value_, the only value of the type with
2813 ### Structure expressions
2816 struct_expr : expr_path '{' ident ':' expr
2817 [ ',' ident ':' expr ] *
2820 [ ',' expr ] * ')' |
2824 There are several forms of structure expressions. A _structure expression_
2825 consists of the [path](#paths) of a [structure item](#structures), followed by
2826 a brace-enclosed list of one or more comma-separated name-value pairs,
2827 providing the field values of a new instance of the structure. A field name
2828 can be any identifier, and is separated from its value expression by a colon.
2829 The location denoted by a structure field is mutable if and only if the
2830 enclosing structure is mutable.
2832 A _tuple structure expression_ consists of the [path](#paths) of a [structure
2833 item](#structures), followed by a parenthesized list of one or more
2834 comma-separated expressions (in other words, the path of a structure item
2835 followed by a tuple expression). The structure item must be a tuple structure
2838 A _unit-like structure expression_ consists only of the [path](#paths) of a
2839 [structure item](#structures).
2841 The following are examples of structure expressions:
2844 # struct Point { x: f64, y: f64 }
2845 # struct TuplePoint(f64, f64);
2846 # mod game { pub struct User<'a> { pub name: &'a str, pub age: uint, pub score: uint } }
2847 # struct Cookie; fn some_fn<T>(t: T) {}
2848 Point {x: 10.0, y: 20.0};
2849 TuplePoint(10.0, 20.0);
2850 let u = game::User {name: "Joe", age: 35, score: 100_000};
2851 some_fn::<Cookie>(Cookie);
2854 A structure expression forms a new value of the named structure type. Note
2855 that for a given *unit-like* structure type, this will always be the same
2858 A structure expression can terminate with the syntax `..` followed by an
2859 expression to denote a functional update. The expression following `..` (the
2860 base) must have the same structure type as the new structure type being formed.
2861 The entire expression denotes the result of constructing a new structure (with
2862 the same type as the base expression) with the given values for the fields that
2863 were explicitly specified and the values in the base expression for all other
2867 # struct Point3d { x: int, y: int, z: int }
2868 let base = Point3d {x: 1, y: 2, z: 3};
2869 Point3d {y: 0, z: 10, .. base};
2872 ### Block expressions
2875 block_expr : '{' [ view_item ] *
2876 [ stmt ';' | item ] *
2880 A _block expression_ is similar to a module in terms of the declarations that
2881 are possible. Each block conceptually introduces a new namespace scope. View
2882 items can bring new names into scopes and declared items are in scope for only
2885 A block will execute each statement sequentially, and then execute the
2886 expression (if given). If the final expression is omitted, the type and return
2887 value of the block are `()`, but if it is provided, the type and return value
2888 of the block are that of the expression itself.
2890 ### Method-call expressions
2893 method_call_expr : expr '.' ident paren_expr_list ;
2896 A _method call_ consists of an expression followed by a single dot, an
2897 identifier, and a parenthesized expression-list. Method calls are resolved to
2898 methods on specific traits, either statically dispatching to a method if the
2899 exact `self`-type of the left-hand-side is known, or dynamically dispatching if
2900 the left-hand-side expression is an indirect [object type](#object-types).
2902 ### Field expressions
2905 field_expr : expr '.' ident ;
2908 A _field expression_ consists of an expression followed by a single dot and an
2909 identifier, when not immediately followed by a parenthesized expression-list
2910 (the latter is a [method call expression](#method-call-expressions)). A field
2911 expression denotes a field of a [structure](#structure-types).
2916 (Struct {a: 10, b: 20}).a;
2919 A field access is an [lvalue](#lvalues,-rvalues-and-temporaries) referring to
2920 the value of that field. When the type providing the field inherits mutability,
2921 it can be [assigned](#assignment-expressions) to.
2923 Also, if the type of the expression to the left of the dot is a pointer, it is
2924 automatically dereferenced to make the field access possible.
2926 ### Array expressions
2929 array_expr : '[' "mut" ? vec_elems? ']' ;
2931 array_elems : [expr [',' expr]*] | [expr ';' expr] ;
2934 An [array](#array,-and-slice-types) _expression_ is written by enclosing zero
2935 or more comma-separated expressions of uniform type in square brackets.
2937 In the `[expr ';' expr]` form, the expression after the `';'` must be a
2938 constant expression that can be evaluated at compile time, such as a
2939 [literal](#literals) or a [static item](#static-items).
2943 ["a", "b", "c", "d"];
2944 [0i; 128]; // array with 128 zeros
2945 [0u8, 0u8, 0u8, 0u8];
2948 ### Index expressions
2951 idx_expr : expr '[' expr ']' ;
2954 [Array](#array,-and-slice-types)-typed expressions can be indexed by
2955 writing a square-bracket-enclosed expression (the index) after them. When the
2956 array is mutable, the resulting [lvalue](#lvalues,-rvalues-and-temporaries) can
2959 Indices are zero-based, and may be of any integral type. Vector access is
2960 bounds-checked at run-time. When the check fails, it will put the thread in a
2965 (["a", "b"])[10]; // panics
2968 ### Unary operator expressions
2970 Rust defines six symbolic unary operators. They are all written as prefix
2971 operators, before the expression they apply to.
2974 : Negation. May only be applied to numeric types.
2976 : Dereference. When applied to a [pointer](#pointer-types) it denotes the
2977 pointed-to location. For pointers to mutable locations, the resulting
2978 [lvalue](#lvalues,-rvalues-and-temporaries) can be assigned to.
2979 On non-pointer types, it calls the `deref` method of the `std::ops::Deref`
2980 trait, or the `deref_mut` method of the `std::ops::DerefMut` trait (if
2981 implemented by the type and required for an outer expression that will or
2982 could mutate the dereference), and produces the result of dereferencing the
2983 `&` or `&mut` borrowed pointer returned from the overload method.
2986 : Logical negation. On the boolean type, this flips between `true` and
2987 `false`. On integer types, this inverts the individual bits in the
2988 two's complement representation of the value.
2990 : [Boxing](#pointer-types) operators. Allocate a box to hold the value they
2991 are applied to, and store the value in it. `box` creates a box.
2993 : Borrow operator. Returns a reference, pointing to its operand. The operand
2994 of a borrow is statically proven to outlive the resulting pointer. If the
2995 borrow-checker cannot prove this, it is a compilation error.
2997 ### Binary operator expressions
3000 binop_expr : expr binop expr ;
3003 Binary operators expressions are given in terms of [operator
3004 precedence](#operator-precedence).
3006 #### Arithmetic operators
3008 Binary arithmetic expressions are syntactic sugar for calls to built-in traits,
3009 defined in the `std::ops` module of the `std` library. This means that
3010 arithmetic operators can be overridden for user-defined types. The default
3011 meaning of the operators on standard types is given here.
3014 : Addition and array/string concatenation.
3015 Calls the `add` method on the `std::ops::Add` trait.
3018 Calls the `sub` method on the `std::ops::Sub` trait.
3021 Calls the `mul` method on the `std::ops::Mul` trait.
3024 Calls the `div` method on the `std::ops::Div` trait.
3027 Calls the `rem` method on the `std::ops::Rem` trait.
3029 #### Bitwise operators
3031 Like the [arithmetic operators](#arithmetic-operators), bitwise operators are
3032 syntactic sugar for calls to methods of built-in traits. This means that
3033 bitwise operators can be overridden for user-defined types. The default
3034 meaning of the operators on standard types is given here.
3038 Calls the `bitand` method of the `std::ops::BitAnd` trait.
3041 Calls the `bitor` method of the `std::ops::BitOr` trait.
3044 Calls the `bitxor` method of the `std::ops::BitXor` trait.
3046 : Logical left shift.
3047 Calls the `shl` method of the `std::ops::Shl` trait.
3049 : Logical right shift.
3050 Calls the `shr` method of the `std::ops::Shr` trait.
3052 #### Lazy boolean operators
3054 The operators `||` and `&&` may be applied to operands of boolean type. The
3055 `||` operator denotes logical 'or', and the `&&` operator denotes logical
3056 'and'. They differ from `|` and `&` in that the right-hand operand is only
3057 evaluated when the left-hand operand does not already determine the result of
3058 the expression. That is, `||` only evaluates its right-hand operand when the
3059 left-hand operand evaluates to `false`, and `&&` only when it evaluates to
3062 #### Comparison operators
3064 Comparison operators are, like the [arithmetic
3065 operators](#arithmetic-operators), and [bitwise operators](#bitwise-operators),
3066 syntactic sugar for calls to built-in traits. This means that comparison
3067 operators can be overridden for user-defined types. The default meaning of the
3068 operators on standard types is given here.
3072 Calls the `eq` method on the `std::cmp::PartialEq` trait.
3075 Calls the `ne` method on the `std::cmp::PartialEq` trait.
3078 Calls the `lt` method on the `std::cmp::PartialOrd` trait.
3081 Calls the `gt` method on the `std::cmp::PartialOrd` trait.
3083 : Less than or equal.
3084 Calls the `le` method on the `std::cmp::PartialOrd` trait.
3086 : Greater than or equal.
3087 Calls the `ge` method on the `std::cmp::PartialOrd` trait.
3089 #### Type cast expressions
3091 A type cast expression is denoted with the binary operator `as`.
3093 Executing an `as` expression casts the value on the left-hand side to the type
3094 on the right-hand side.
3096 A numeric value can be cast to any numeric type. A raw pointer value can be
3097 cast to or from any integral type or raw pointer type. Any other cast is
3098 unsupported and will fail to compile.
3100 An example of an `as` expression:
3103 # fn sum(v: &[f64]) -> f64 { 0.0 }
3104 # fn len(v: &[f64]) -> int { 0 }
3106 fn avg(v: &[f64]) -> f64 {
3107 let sum: f64 = sum(v);
3108 let sz: f64 = len(v) as f64;
3113 #### Assignment expressions
3115 An _assignment expression_ consists of an
3116 [lvalue](#lvalues,-rvalues-and-temporaries) expression followed by an equals
3117 sign (`=`) and an [rvalue](#lvalues,-rvalues-and-temporaries) expression.
3119 Evaluating an assignment expression [either copies or
3120 moves](#moved-and-copied-types) its right-hand operand to its left-hand
3130 #### Compound assignment expressions
3132 The `+`, `-`, `*`, `/`, `%`, `&`, `|`, `^`, `<<`, and `>>` operators may be
3133 composed with the `=` operator. The expression `lval OP= val` is equivalent to
3134 `lval = lval OP val`. For example, `x = x + 1` may be written as `x += 1`.
3136 Any such expression always has the [`unit`](#primitive-types) type.
3138 #### Operator precedence
3140 The precedence of Rust binary operators is ordered as follows, going from
3143 ```{.text .precedence}
3158 Operators at the same precedence level are evaluated left-to-right. [Unary
3159 operators](#unary-operator-expressions) have the same precedence level and are
3160 stronger than any of the binary operators.
3162 ### Grouped expressions
3164 An expression enclosed in parentheses evaluates to the result of the enclosed
3165 expression. Parentheses can be used to explicitly specify evaluation order
3166 within an expression.
3169 paren_expr : '(' expr ')' ;
3172 An example of a parenthesized expression:
3175 let x: int = (2 + 3) * 4;
3179 ### Call expressions
3182 expr_list : [ expr [ ',' expr ]* ] ? ;
3183 paren_expr_list : '(' expr_list ')' ;
3184 call_expr : expr paren_expr_list ;
3187 A _call expression_ invokes a function, providing zero or more input slots and
3188 an optional reference slot to serve as the function's output, bound to the
3189 `lval` on the right hand side of the call. If the function eventually returns,
3190 then the expression completes.
3192 Some examples of call expressions:
3195 # fn add(x: int, y: int) -> int { 0 }
3197 let x: int = add(1, 2);
3198 let pi: Option<f32> = "3.14".parse();
3201 ### Lambda expressions
3204 ident_list : [ ident [ ',' ident ]* ] ? ;
3205 lambda_expr : '|' ident_list '|' expr ;
3208 A _lambda expression_ (sometimes called an "anonymous function expression")
3209 defines a function and denotes it as a value, in a single expression. A lambda
3210 expression is a pipe-symbol-delimited (`|`) list of identifiers followed by an
3213 A lambda expression denotes a function that maps a list of parameters
3214 (`ident_list`) onto the expression that follows the `ident_list`. The
3215 identifiers in the `ident_list` are the parameters to the function. These
3216 parameters' types need not be specified, as the compiler infers them from
3219 Lambda expressions are most useful when passing functions as arguments to other
3220 functions, as an abbreviation for defining and capturing a separate function.
3222 Significantly, lambda expressions _capture their environment_, which regular
3223 [function definitions](#functions) do not. The exact type of capture depends
3224 on the [function type](#function-types) inferred for the lambda expression. In
3225 the simplest and least-expensive form (analogous to a ```|| { }``` expression),
3226 the lambda expression captures its environment by reference, effectively
3227 borrowing pointers to all outer variables mentioned inside the function.
3228 Alternately, the compiler may infer that a lambda expression should copy or
3229 move values (depending on their type) from the environment into the lambda
3230 expression's captured environment.
3232 In this example, we define a function `ten_times` that takes a higher-order
3233 function argument, and call it with a lambda expression as an argument:
3236 fn ten_times<F>(f: F) where F: Fn(int) {
3244 ten_times(|j| println!("hello, {}", j));
3250 while_expr : "while" no_struct_literal_expr '{' block '}' ;
3253 A `while` loop begins by evaluating the boolean loop conditional expression.
3254 If the loop conditional expression evaluates to `true`, the loop body block
3255 executes and control returns to the loop conditional expression. If the loop
3256 conditional expression evaluates to `false`, the `while` expression completes.
3271 A `loop` expression denotes an infinite loop.
3274 loop_expr : [ lifetime ':' ] "loop" '{' block '}';
3277 A `loop` expression may optionally have a _label_. If a label is present, then
3278 labeled `break` and `continue` expressions nested within this loop may exit out
3279 of this loop or return control to its head. See [Break
3280 expressions](#break-expressions) and [Continue
3281 expressions](#continue-expressions).
3283 ### Break expressions
3286 break_expr : "break" [ lifetime ];
3289 A `break` expression has an optional _label_. If the label is absent, then
3290 executing a `break` expression immediately terminates the innermost loop
3291 enclosing it. It is only permitted in the body of a loop. If the label is
3292 present, then `break foo` terminates the loop with label `foo`, which need not
3293 be the innermost label enclosing the `break` expression, but must enclose it.
3295 ### Continue expressions
3298 continue_expr : "continue" [ lifetime ];
3301 A `continue` expression has an optional _label_. If the label is absent, then
3302 executing a `continue` expression immediately terminates the current iteration
3303 of the innermost loop enclosing it, returning control to the loop *head*. In
3304 the case of a `while` loop, the head is the conditional expression controlling
3305 the loop. In the case of a `for` loop, the head is the call-expression
3306 controlling the loop. If the label is present, then `continue foo` returns
3307 control to the head of the loop with label `foo`, which need not be the
3308 innermost label enclosing the `break` expression, but must enclose it.
3310 A `continue` expression is only permitted in the body of a loop.
3315 for_expr : "for" pat "in" no_struct_literal_expr '{' block '}' ;
3318 A `for` expression is a syntactic construct for looping over elements provided
3319 by an implementation of `std::iter::Iterator`.
3321 An example of a for loop over the contents of an array:
3325 # fn bar(f: Foo) { }
3330 let v: &[Foo] = &[a, b, c];
3337 An example of a for loop over a series of integers:
3340 # fn bar(b:uint) { }
3341 for i in range(0u, 256) {
3349 if_expr : "if" no_struct_literal_expr '{' block '}'
3352 else_tail : "else" [ if_expr | if_let_expr
3356 An `if` expression is a conditional branch in program control. The form of an
3357 `if` expression is a condition expression, followed by a consequent block, any
3358 number of `else if` conditions and blocks, and an optional trailing `else`
3359 block. The condition expressions must have type `bool`. If a condition
3360 expression evaluates to `true`, the consequent block is executed and any
3361 subsequent `else if` or `else` block is skipped. If a condition expression
3362 evaluates to `false`, the consequent block is skipped and any subsequent `else
3363 if` condition is evaluated. If all `if` and `else if` conditions evaluate to
3364 `false` then any `else` block is executed.
3366 ### Match expressions
3369 match_expr : "match" no_struct_literal_expr '{' match_arm * '}' ;
3371 match_arm : attribute * match_pat "=>" [ expr "," | '{' block '}' ] ;
3373 match_pat : pat [ '|' pat ] * [ "if" expr ] ? ;
3376 A `match` expression branches on a *pattern*. The exact form of matching that
3377 occurs depends on the pattern. Patterns consist of some combination of
3378 literals, destructured arrays or enum constructors, structures and tuples,
3379 variable binding specifications, wildcards (`..`), and placeholders (`_`). A
3380 `match` expression has a *head expression*, which is the value to compare to
3381 the patterns. The type of the patterns must equal the type of the head
3384 In a pattern whose head expression has an `enum` type, a placeholder (`_`)
3385 stands for a *single* data field, whereas a wildcard `..` stands for *all* the
3386 fields of a particular variant. For example:
3389 #![feature(box_syntax)]
3390 enum List<X> { Nil, Cons(X, Box<List<X>>) }
3393 let x: List<int> = List::Cons(10, box List::Cons(11, box List::Nil));
3396 List::Cons(_, box List::Nil) => panic!("singleton list"),
3397 List::Cons(..) => return,
3398 List::Nil => panic!("empty list")
3403 The first pattern matches lists constructed by applying `Cons` to any head
3404 value, and a tail value of `box Nil`. The second pattern matches _any_ list
3405 constructed with `Cons`, ignoring the values of its arguments. The difference
3406 between `_` and `..` is that the pattern `C(_)` is only type-correct if `C` has
3407 exactly one argument, while the pattern `C(..)` is type-correct for any enum
3408 variant `C`, regardless of how many arguments `C` has.
3410 Used inside an array pattern, `..` stands for any number of elements, when the
3411 `advanced_slice_patterns` feature gate is turned on. This wildcard can be used
3412 at most once for a given array, which implies that it cannot be used to
3413 specifically match elements that are at an unknown distance from both ends of a
3414 array, like `[.., 42, ..]`. If followed by a variable name, it will bind the
3415 corresponding slice to the variable. Example:
3418 # #![feature(advanced_slice_patterns)]
3419 fn is_symmetric(list: &[uint]) -> bool {
3422 [x, inside.., y] if x == y => is_symmetric(inside),
3428 let sym = &[0, 1, 4, 2, 4, 1, 0];
3429 let not_sym = &[0, 1, 7, 2, 4, 1, 0];
3430 assert!(is_symmetric(sym));
3431 assert!(!is_symmetric(not_sym));
3435 A `match` behaves differently depending on whether or not the head expression
3436 is an [lvalue or an rvalue](#lvalues,-rvalues-and-temporaries). If the head
3437 expression is an rvalue, it is first evaluated into a temporary location, and
3438 the resulting value is sequentially compared to the patterns in the arms until
3439 a match is found. The first arm with a matching pattern is chosen as the branch
3440 target of the `match`, any variables bound by the pattern are assigned to local
3441 variables in the arm's block, and control enters the block.
3443 When the head expression is an lvalue, the match does not allocate a temporary
3444 location (however, a by-value binding may copy or move from the lvalue). When
3445 possible, it is preferable to match on lvalues, as the lifetime of these
3446 matches inherits the lifetime of the lvalue, rather than being restricted to
3447 the inside of the match.
3449 An example of a `match` expression:
3452 #![feature(box_syntax)]
3453 # fn process_pair(a: int, b: int) { }
3454 # fn process_ten() { }
3456 enum List<X> { Nil, Cons(X, Box<List<X>>) }
3459 let x: List<int> = List::Cons(10, box List::Cons(11, box List::Nil));
3462 List::Cons(a, box List::Cons(b, _)) => {
3465 List::Cons(10, _) => {
3478 Patterns that bind variables default to binding to a copy or move of the
3479 matched value (depending on the matched value's type). This can be changed to
3480 bind to a reference by using the `ref` keyword, or to a mutable reference using
3483 Subpatterns can also be bound to variables by the use of the syntax `variable @
3484 subpattern`. For example:
3487 #![feature(box_syntax)]
3489 enum List { Nil, Cons(uint, Box<List>) }
3491 fn is_sorted(list: &List) -> bool {
3493 List::Nil | List::Cons(_, box List::Nil) => true,
3494 List::Cons(x, ref r @ box List::Cons(_, _)) => {
3496 box List::Cons(y, _) => (x <= y) && is_sorted(&**r),
3504 let a = List::Cons(6, box List::Cons(7, box List::Cons(42, box List::Nil)));
3505 assert!(is_sorted(&a));
3510 Patterns can also dereference pointers by using the `&`, `&mut` and `box`
3511 symbols, as appropriate. For example, these two matches on `x: &int` are
3516 let y = match *x { 0 => "zero", _ => "some" };
3517 let z = match x { &0 => "zero", _ => "some" };
3522 A pattern that's just an identifier, like `Nil` in the previous example, could
3523 either refer to an enum variant that's in scope, or bind a new variable. The
3524 compiler resolves this ambiguity by forbidding variable bindings that occur in
3525 `match` patterns from shadowing names of variants that are in scope. For
3526 example, wherever `List` is in scope, a `match` pattern would not be able to
3527 bind `Nil` as a new name. The compiler interprets a variable pattern `x` as a
3528 binding _only_ if there is no variant named `x` in scope. A convention you can
3529 use to avoid conflicts is simply to name variants with upper-case letters, and
3530 local variables with lower-case letters.
3532 Multiple match patterns may be joined with the `|` operator. A range of values
3533 may be specified with `...`. For example:
3538 let message = match x {
3539 0 | 1 => "not many",
3545 Range patterns only work on scalar types (like integers and characters; not
3546 like arrays and structs, which have sub-components). A range pattern may not
3547 be a sub-range of another range pattern inside the same `match`.
3549 Finally, match patterns can accept *pattern guards* to further refine the
3550 criteria for matching a case. Pattern guards appear after the pattern and
3551 consist of a bool-typed expression following the `if` keyword. A pattern guard
3552 may refer to the variables bound within the pattern they follow.
3555 # let maybe_digit = Some(0);
3556 # fn process_digit(i: int) { }
3557 # fn process_other(i: int) { }
3559 let message = match maybe_digit {
3560 Some(x) if x < 10 => process_digit(x),
3561 Some(x) => process_other(x),
3566 ### If let expressions
3569 if_let_expr : "if" "let" pat '=' expr '{' block '}'
3571 else_tail : "else" [ if_expr | if_let_expr | '{' block '}' ] ;
3574 An `if let` expression is semantically identical to an `if` expression but in place
3575 of a condition expression it expects a refutable let statement. If the value of the
3576 expression on the right hand side of the let statement matches the pattern, the corresponding
3577 block will execute, otherwise flow proceeds to the first `else` block that follows.
3582 while_let_expr : "while" "let" pat '=' expr '{' block '}' ;
3585 A `while let` loop is semantically identical to a `while` loop but in place of a
3586 condition expression it expects a refutable let statement. If the value of the
3587 expression on the right hand side of the let statement matches the pattern, the
3588 loop body block executes and control returns to the pattern matching statement.
3589 Otherwise, the while expression completes.
3591 ### Return expressions
3594 return_expr : "return" expr ? ;
3597 Return expressions are denoted with the keyword `return`. Evaluating a `return`
3598 expression moves its argument into the output slot of the current function,
3599 destroys the current function activation frame, and transfers control to the
3602 An example of a `return` expression:
3605 fn max(a: int, b: int) -> int {
3617 Every slot, item and value in a Rust program has a type. The _type_ of a
3618 *value* defines the interpretation of the memory holding it.
3620 Built-in types and type-constructors are tightly integrated into the language,
3621 in nontrivial ways that are not possible to emulate in user-defined types.
3622 User-defined types have limited capabilities.
3626 The primitive types are the following:
3628 * The "unit" type `()`, having the single "unit" value `()` (occasionally called
3630 * The boolean type `bool` with values `true` and `false`.
3631 * The machine types.
3632 * The machine-dependent integer and floating-point types.
3634 [^unittype]: The "unit" value `()` is *not* a sentinel "null pointer" value for
3635 reference slots; the "unit" type is the implicit return type from functions
3636 otherwise lacking a return type, and can be used in other contexts (such as
3637 message-sending or type-parametric code) as a zero-size type.]
3641 The machine types are the following:
3643 * The unsigned word types `u8`, `u16`, `u32` and `u64`, with values drawn from
3644 the integer intervals [0, 2^8 - 1], [0, 2^16 - 1], [0, 2^32 - 1] and
3645 [0, 2^64 - 1] respectively.
3647 * The signed two's complement word types `i8`, `i16`, `i32` and `i64`, with
3648 values drawn from the integer intervals [-(2^(7)), 2^7 - 1],
3649 [-(2^(15)), 2^15 - 1], [-(2^(31)), 2^31 - 1], [-(2^(63)), 2^63 - 1]
3652 * The IEEE 754-2008 `binary32` and `binary64` floating-point types: `f32` and
3653 `f64`, respectively.
3655 #### Machine-dependent integer types
3657 The `uint` type is an unsigned integer type with the same number of bits as the
3658 platform's pointer type. It can represent every memory address in the process.
3660 The `int` type is a signed integer type with the same number of bits as the
3661 platform's pointer type. The theoretical upper bound on object and array size
3662 is the maximum `int` value. This ensures that `int` can be used to calculate
3663 differences between pointers into an object or array and can address every byte
3664 within an object along with one byte past the end.
3668 The types `char` and `str` hold textual data.
3670 A value of type `char` is a [Unicode scalar value](
3671 http://www.unicode.org/glossary/#unicode_scalar_value) (i.e. a code point that
3672 is not a surrogate), represented as a 32-bit unsigned word in the 0x0000 to
3673 0xD7FF or 0xE000 to 0x10FFFF range. A `[char]` array is effectively an UCS-4 /
3676 A value of type `str` is a Unicode string, represented as an array of 8-bit
3677 unsigned bytes holding a sequence of UTF-8 codepoints. Since `str` is of
3678 unknown size, it is not a _first-class_ type, but can only be instantiated
3679 through a pointer type, such as `&str` or `String`.
3683 A tuple *type* is a heterogeneous product of other types, called the *elements*
3684 of the tuple. It has no nominal name and is instead structurally typed.
3686 Tuple types and values are denoted by listing the types or values of their
3687 elements, respectively, in a parenthesized, comma-separated list.
3689 Because tuple elements don't have a name, they can only be accessed by
3692 The members of a tuple are laid out in memory contiguously, in order specified
3695 An example of a tuple type and its use:
3698 type Pair<'a> = (int, &'a str);
3699 let p: Pair<'static> = (10, "hello");
3701 assert!(b != "world");
3704 ### Array, and Slice types
3706 Rust has two different types for a list of items:
3708 * `[T; N]`, an 'array'.
3709 * `&[T]`, a 'slice'.
3711 An array has a fixed size, and can be allocated on either the stack or the
3714 A slice is a 'view' into an array. It doesn't own the data it points
3717 An example of each kind:
3720 let vec: Vec<i32> = vec![1, 2, 3];
3721 let arr: [i32; 3] = [1, 2, 3];
3722 let s: &[i32] = vec.as_slice();
3725 As you can see, the `vec!` macro allows you to create a `Vec<T>` easily. The
3726 `vec!` macro is also part of the standard library, rather than the language.
3728 All in-bounds elements of arrays, and slices are always initialized, and access
3729 to an array or slice is always bounds-checked.
3733 A `struct` *type* is a heterogeneous product of other types, called the
3734 *fields* of the type.[^structtype]
3736 [^structtype]: `struct` types are analogous `struct` types in C,
3737 the *record* types of the ML family,
3738 or the *structure* types of the Lisp family.
3740 New instances of a `struct` can be constructed with a [struct
3741 expression](#structure-expressions).
3743 The memory layout of a `struct` is undefined by default to allow for compiler
3744 optimizations like field reordering, but it can be fixed with the
3745 `#[repr(...)]` attribute. In either case, fields may be given in any order in
3746 a corresponding struct *expression*; the resulting `struct` value will always
3747 have the same memory layout.
3749 The fields of a `struct` may be qualified by [visibility
3750 modifiers](#re-exporting-and-visibility), to allow access to data in a
3751 structure outside a module.
3753 A _tuple struct_ type is just like a structure type, except that the fields are
3756 A _unit-like struct_ type is like a structure type, except that it has no
3757 fields. The one value constructed by the associated [structure
3758 expression](#structure-expressions) is the only value that inhabits such a
3761 ### Enumerated types
3763 An *enumerated type* is a nominal, heterogeneous disjoint union type, denoted
3764 by the name of an [`enum` item](#enumerations). [^enumtype]
3766 [^enumtype]: The `enum` type is analogous to a `data` constructor declaration in
3767 ML, or a *pick ADT* in Limbo.
3769 An [`enum` item](#enumerations) declares both the type and a number of *variant
3770 constructors*, each of which is independently named and takes an optional tuple
3773 New instances of an `enum` can be constructed by calling one of the variant
3774 constructors, in a [call expression](#call-expressions).
3776 Any `enum` value consumes as much memory as the largest variant constructor for
3777 its corresponding `enum` type.
3779 Enum types cannot be denoted *structurally* as types, but must be denoted by
3780 named reference to an [`enum` item](#enumerations).
3784 Nominal types — [enumerations](#enumerated-types) and
3785 [structures](#structure-types) — may be recursive. That is, each `enum`
3786 constructor or `struct` field may refer, directly or indirectly, to the
3787 enclosing `enum` or `struct` type itself. Such recursion has restrictions:
3789 * Recursive types must include a nominal type in the recursion
3790 (not mere [type definitions](#type-definitions),
3791 or other structural types such as [arrays](#array,-and-slice-types) or [tuples](#tuple-types)).
3792 * A recursive `enum` item must have at least one non-recursive constructor
3793 (in order to give the recursion a basis case).
3794 * The size of a recursive type must be finite;
3795 in other words the recursive fields of the type must be [pointer types](#pointer-types).
3796 * Recursive type definitions can cross module boundaries, but not module *visibility* boundaries,
3797 or crate boundaries (in order to simplify the module system and type checker).
3799 An example of a *recursive* type and its use:
3802 # use std::boxed::Box;
3805 Cons(T, Box<List<T>>)
3808 let a: List<i32> = List::Cons(7, Box::new(List::Cons(13, Box::new(List::Nil))));
3813 All pointers in Rust are explicit first-class values. They can be copied,
3814 stored into data structures, and returned from functions. There are two
3815 varieties of pointer in Rust:
3818 : These point to memory _owned by some other value_.
3819 A reference type is written `&type` for some lifetime-variable `f`,
3820 or just `&'a type` when you need an explicit lifetime.
3821 Copying a reference is a "shallow" operation:
3822 it involves only copying the pointer itself.
3823 Releasing a reference typically has no effect on the value it points to,
3824 with the exception of temporary values, which are released when the last
3825 reference to them is released.
3827 * Raw pointers (`*`)
3828 : Raw pointers are pointers without safety or liveness guarantees.
3829 Raw pointers are written as `*const T` or `*mut T`,
3830 for example `*const int` means a raw pointer to an integer.
3831 Copying or dropping a raw pointer has no effect on the lifecycle of any
3832 other value. Dereferencing a raw pointer or converting it to any other
3833 pointer type is an [`unsafe` operation](#unsafe-functions).
3834 Raw pointers are generally discouraged in Rust code;
3835 they exist to support interoperability with foreign code,
3836 and writing performance-critical or low-level functions.
3838 The standard library contains additional 'smart pointer' types beyond references
3843 The function type constructor `fn` forms new function types. A function type
3844 consists of a possibly-empty set of function-type modifiers (such as `unsafe`
3845 or `extern`), a sequence of input types and an output type.
3847 An example of a `fn` type:
3850 fn add(x: int, y: int) -> int {
3854 let mut x = add(5,7);
3856 type Binop = fn(int, int) -> int;
3857 let bo: Binop = add;
3863 ```{.ebnf .notation}
3864 closure_type := [ 'unsafe' ] [ '<' lifetime-list '>' ] '|' arg-list '|'
3865 [ ':' bound-list ] [ '->' type ]
3866 lifetime-list := lifetime | lifetime ',' lifetime-list
3867 arg-list := ident ':' type | ident ':' type ',' arg-list
3868 bound-list := bound | bound '+' bound-list
3869 bound := path | lifetime
3872 The type of a closure mapping an input of type `A` to an output of type `B` is
3873 `|A| -> B`. A closure with no arguments or return values has type `||`.
3875 An example of creating and calling a closure:
3878 let captured_var = 10i;
3880 let closure_no_args = |&:| println!("captured_var={}", captured_var);
3882 let closure_args = |&: arg: int| -> int {
3883 println!("captured_var={}, arg={}", captured_var, arg);
3884 arg // Note lack of semicolon after 'arg'
3887 fn call_closure<F: Fn(), G: Fn(int) -> int>(c1: F, c2: G) {
3892 call_closure(closure_no_args, closure_args);
3898 Every trait item (see [traits](#traits)) defines a type with the same name as
3899 the trait. This type is called the _object type_ of the trait. Object types
3900 permit "late binding" of methods, dispatched using _virtual method tables_
3901 ("vtables"). Whereas most calls to trait methods are "early bound" (statically
3902 resolved) to specific implementations at compile time, a call to a method on an
3903 object type is only resolved to a vtable entry at compile time. The actual
3904 implementation for each vtable entry can vary on an object-by-object basis.
3906 Given a pointer-typed expression `E` of type `&T` or `Box<T>`, where `T`
3907 implements trait `R`, casting `E` to the corresponding pointer type `&R` or
3908 `Box<R>` results in a value of the _object type_ `R`. This result is
3909 represented as a pair of pointers: the vtable pointer for the `T`
3910 implementation of `R`, and the pointer value of `E`.
3912 An example of an object type:
3915 # use std::boxed::Box;
3917 fn stringify(&self) -> String;
3920 impl Printable for int {
3921 fn stringify(&self) -> String { self.to_string() }
3924 fn print(a: Box<Printable>) {
3925 println!("{}", a.stringify());
3929 print(Box::new(10i) as Box<Printable>);
3933 In this example, the trait `Printable` occurs as an object type in both the
3934 type signature of `print`, and the cast expression in `main`.
3938 Within the body of an item that has type parameter declarations, the names of
3939 its type parameters are types:
3942 fn map<A: Clone, B: Clone>(f: |A| -> B, xs: &[A]) -> Vec<B> {
3946 let first: B = f(xs[0].clone());
3947 let mut rest: Vec<B> = map(f, xs.slice(1, xs.len()));
3948 rest.insert(0, first);
3953 Here, `first` has type `B`, referring to `map`'s `B` type parameter; and `rest`
3954 has type `Vec<B>`, a vector type with element type `B`.
3958 The special type `self` has a meaning within methods inside an impl item. It
3959 refers to the type of the implicit `self` argument. For example, in:
3963 fn make_string(&self) -> String;
3966 impl Printable for String {
3967 fn make_string(&self) -> String {
3973 `self` refers to the value of type `String` that is the receiver for a call to
3974 the method `make_string`.
3978 Types in Rust are categorized into kinds, based on various properties of the
3979 components of the type. The kinds are:
3982 : Types of this kind can be safely sent between threads.
3983 This kind includes scalars, boxes, procs, and
3984 structural types containing only other owned types.
3985 All `Send` types are `'static`.
3987 : Types of this kind consist of "Plain Old Data"
3988 which can be copied by simply moving bits.
3989 All values of this kind can be implicitly copied.
3990 This kind includes scalars and immutable references,
3991 as well as structural types containing other `Copy` types.
3993 : Types of this kind do not contain any references (except for
3994 references with the `static` lifetime, which are allowed).
3995 This can be a useful guarantee for code
3996 that breaks borrowing assumptions
3997 using [`unsafe` operations](#unsafe-functions).
3999 : This is not strictly a kind,
4000 but its presence interacts with kinds:
4001 the `Drop` trait provides a single method `drop`
4002 that takes no parameters,
4003 and is run when values of the type are dropped.
4004 Such a method is called a "destructor",
4005 and are always executed in "top-down" order:
4006 a value is completely destroyed
4007 before any of the values it owns run their destructors.
4008 Only `Send` types can implement `Drop`.
4011 : Types with destructors, closure environments,
4012 and various other _non-first-class_ types,
4013 are not copyable at all.
4014 Such types can usually only be accessed through pointers,
4015 or in some cases, moved between mutable locations.
4017 Kinds can be supplied as _bounds_ on type parameters, like traits, in which
4018 case the parameter is constrained to types satisfying that kind.
4020 By default, type parameters do not carry any assumed kind-bounds at all. When
4021 instantiating a type parameter, the kind bounds on the parameter are checked to
4022 be the same or narrower than the kind of the type that it is instantiated with.
4024 Sending operations are not part of the Rust language, but are implemented in
4025 the library. Generic functions that send values bound the kind of these values
4028 # Memory and concurrency models
4030 Rust has a memory model centered around concurrently-executing _threads_. Thus
4031 its memory model and its concurrency model are best discussed simultaneously,
4032 as parts of each only make sense when considered from the perspective of the
4035 When reading about the memory model, keep in mind that it is partitioned in
4036 order to support threads; and when reading about threads, keep in mind that their
4037 isolation and communication mechanisms are only possible due to the ownership
4038 and lifetime semantics of the memory model.
4042 A Rust program's memory consists of a static set of *items*, a set of
4043 [threads](#threads) each with its own *stack*, and a *heap*. Immutable portions of
4044 the heap may be shared between threads, mutable portions may not.
4046 Allocations in the stack consist of *slots*, and allocations in the heap
4049 ### Memory allocation and lifetime
4051 The _items_ of a program are those functions, modules and types that have their
4052 value calculated at compile-time and stored uniquely in the memory image of the
4053 rust process. Items are neither dynamically allocated nor freed.
4055 A thread's _stack_ consists of activation frames automatically allocated on entry
4056 to each function as the thread executes. A stack allocation is reclaimed when
4057 control leaves the frame containing it.
4059 The _heap_ is a general term that describes boxes. The lifetime of an
4060 allocation in the heap depends on the lifetime of the box values pointing to
4061 it. Since box values may themselves be passed in and out of frames, or stored
4062 in the heap, heap allocations may outlive the frame they are allocated within.
4064 ### Memory ownership
4066 A thread owns all memory it can *safely* reach through local variables, as well
4067 as boxes and references.
4069 When a thread sends a value that has the `Send` trait to another thread, it loses
4070 ownership of the value sent and can no longer refer to it. This is statically
4071 guaranteed by the combined use of "move semantics", and the compiler-checked
4072 _meaning_ of the `Send` trait: it is only instantiated for (transitively)
4073 sendable kinds of data constructor and pointers, never including references.
4075 When a stack frame is exited, its local allocations are all released, and its
4076 references to boxes are dropped.
4078 When a thread finishes, its stack is necessarily empty and it therefore has no
4079 references to any boxes; the remainder of its heap is immediately freed.
4083 A thread's stack contains slots.
4085 A _slot_ is a component of a stack frame, either a function parameter, a
4086 [temporary](#lvalues,-rvalues-and-temporaries), or a local variable.
4088 A _local variable_ (or *stack-local* allocation) holds a value directly,
4089 allocated within the stack's memory. The value is a part of the stack frame.
4091 Local variables are immutable unless declared otherwise like: `let mut x = ...`.
4093 Function parameters are immutable unless declared with `mut`. The `mut` keyword
4094 applies only to the following parameter (so `|mut x, y|` and `fn f(mut x:
4095 Box<int>, y: Box<int>)` declare one mutable variable `x` and one immutable
4098 Methods that take either `self` or `Box<Self>` can optionally place them in a
4099 mutable slot by prefixing them with `mut` (similar to regular arguments):
4103 fn change(mut self) -> Self;
4104 fn modify(mut self: Box<Self>) -> Box<Self>;
4108 Local variables are not initialized when allocated; the entire frame worth of
4109 local variables are allocated at once, on frame-entry, in an uninitialized
4110 state. Subsequent statements within a function may or may not initialize the
4111 local variables. Local variables can be used only after they have been
4112 initialized; this is enforced by the compiler.
4116 A _box_ is a reference to a heap allocation holding another value, which is
4117 constructed by the prefix operator `box`. When the standard library is in use,
4118 the type of a box is `std::owned::Box<T>`.
4120 An example of a box type and value:
4123 # use std::boxed::Box;
4124 let x: Box<int> = Box::new(10);
4127 Box values exist in 1:1 correspondence with their heap allocation, copying a
4128 box value makes a shallow copy of the pointer. Rust will consider a shallow
4129 copy of a box to move ownership of the value. After a value has been moved,
4130 the source location cannot be used unless it is reinitialized.
4133 # use std::boxed::Box;
4134 let x: Box<int> = Box::new(10);
4136 // attempting to use `x` will result in an error here
4141 Rust's primary concurrency mechanism is called a **thread**.
4143 ### Communication between threads
4145 Rust threads are isolated and generally unable to interfere with one another's
4146 memory directly, except through [`unsafe` code](#unsafe-functions). All
4147 contact between threads is mediated by safe forms of ownership transfer, and data
4148 races on memory are prohibited by the type system.
4150 When you wish to send data between threads, the values are restricted to the
4151 [`Send` type-kind](#type-kinds). Restricting communication interfaces to this
4152 kind ensures that no references move between threads. Thus access to an entire
4153 data structure can be mediated through its owning "root" value; no further
4154 locking or copying is required to avoid data races within the substructure of
4159 The _lifecycle_ of a threads consists of a finite set of states and events that
4160 cause transitions between the states. The lifecycle states of a thread are:
4167 A thread begins its lifecycle — once it has been spawned — in the
4168 *running* state. In this state it executes the statements of its entry
4169 function, and any functions called by the entry function.
4171 A thread may transition from the *running* state to the *blocked* state any time
4172 it makes a blocking communication call. When the call can be completed —
4173 when a message arrives at a sender, or a buffer opens to receive a message
4174 — then the blocked thread will unblock and transition back to *running*.
4176 A thread may transition to the *panicked* state at any time, due being killed by
4177 some external event or internally, from the evaluation of a `panic!()` macro.
4178 Once *panicking*, a thread unwinds its stack and transitions to the *dead* state.
4179 Unwinding the stack of a thread is done by the thread itself, on its own control
4180 stack. If a value with a destructor is freed during unwinding, the code for the
4181 destructor is run, also on the thread's control stack. Running the destructor
4182 code causes a temporary transition to a *running* state, and allows the
4183 destructor code to cause any subsequent state transitions. The original thread
4184 of unwinding and panicking thereby may suspend temporarily, and may involve
4185 (recursive) unwinding of the stack of a failed destructor. Nonetheless, the
4186 outermost unwinding activity will continue until the stack is unwound and the
4187 thread transitions to the *dead* state. There is no way to "recover" from thread
4188 panics. Once a thread has temporarily suspended its unwinding in the *panicking*
4189 state, a panic occurring from within this destructor results in *hard* panic.
4190 A hard panic currently results in the process aborting.
4192 A thread in the *dead* state cannot transition to other states; it exists only to
4193 have its termination status inspected by other threads, and/or to await
4194 reclamation when the last reference to it drops.
4196 # Runtime services, linkage and debugging
4198 The Rust _runtime_ is a relatively compact collection of Rust code that
4199 provides fundamental services and datatypes to all Rust threads at run-time. It
4200 is smaller and simpler than many modern language runtimes. It is tightly
4201 integrated into the language's execution model of memory, threads, communication
4204 ### Memory allocation
4206 The runtime memory-management system is based on a _service-provider
4207 interface_, through which the runtime requests blocks of memory from its
4208 environment and releases them back to its environment when they are no longer
4209 needed. The default implementation of the service-provider interface consists
4210 of the C runtime functions `malloc` and `free`.
4212 The runtime memory-management system, in turn, supplies Rust threads with
4213 facilities for allocating releasing stacks, as well as allocating and freeing
4218 The runtime provides C and Rust code to assist with various built-in types,
4219 such as arrays, strings, and the low level communication system (ports,
4222 Support for other built-in types such as simple types, tuples and enums is
4223 open-coded by the Rust compiler.
4225 ### Thread scheduling and communication
4227 The runtime provides code to manage inter-thread communication. This includes
4228 the system of thread-lifecycle state transitions depending on the contents of
4229 queues, as well as code to copy values between queues and their recipients and
4230 to serialize values for transmission over operating-system inter-process
4231 communication facilities.
4235 The Rust compiler supports various methods to link crates together both
4236 statically and dynamically. This section will explore the various methods to
4237 link Rust crates together, and more information about native libraries can be
4238 found in the [ffi section of the book][ffi].
4240 In one session of compilation, the compiler can generate multiple artifacts
4241 through the usage of either command line flags or the `crate_type` attribute.
4242 If one or more command line flag is specified, all `crate_type` attributes will
4243 be ignored in favor of only building the artifacts specified by command line.
4245 * `--crate-type=bin`, `#[crate_type = "bin"]` - A runnable executable will be
4246 produced. This requires that there is a `main` function in the crate which
4247 will be run when the program begins executing. This will link in all Rust and
4248 native dependencies, producing a distributable binary.
4250 * `--crate-type=lib`, `#[crate_type = "lib"]` - A Rust library will be produced.
4251 This is an ambiguous concept as to what exactly is produced because a library
4252 can manifest itself in several forms. The purpose of this generic `lib` option
4253 is to generate the "compiler recommended" style of library. The output library
4254 will always be usable by rustc, but the actual type of library may change from
4255 time-to-time. The remaining output types are all different flavors of
4256 libraries, and the `lib` type can be seen as an alias for one of them (but the
4257 actual one is compiler-defined).
4259 * `--crate-type=dylib`, `#[crate_type = "dylib"]` - A dynamic Rust library will
4260 be produced. This is different from the `lib` output type in that this forces
4261 dynamic library generation. The resulting dynamic library can be used as a
4262 dependency for other libraries and/or executables. This output type will
4263 create `*.so` files on linux, `*.dylib` files on osx, and `*.dll` files on
4266 * `--crate-type=staticlib`, `#[crate_type = "staticlib"]` - A static system
4267 library will be produced. This is different from other library outputs in that
4268 the Rust compiler will never attempt to link to `staticlib` outputs. The
4269 purpose of this output type is to create a static library containing all of
4270 the local crate's code along with all upstream dependencies. The static
4271 library is actually a `*.a` archive on linux and osx and a `*.lib` file on
4272 windows. This format is recommended for use in situations such as linking
4273 Rust code into an existing non-Rust application because it will not have
4274 dynamic dependencies on other Rust code.
4276 * `--crate-type=rlib`, `#[crate_type = "rlib"]` - A "Rust library" file will be
4277 produced. This is used as an intermediate artifact and can be thought of as a
4278 "static Rust library". These `rlib` files, unlike `staticlib` files, are
4279 interpreted by the Rust compiler in future linkage. This essentially means
4280 that `rustc` will look for metadata in `rlib` files like it looks for metadata
4281 in dynamic libraries. This form of output is used to produce statically linked
4282 executables as well as `staticlib` outputs.
4284 Note that these outputs are stackable in the sense that if multiple are
4285 specified, then the compiler will produce each form of output at once without
4286 having to recompile. However, this only applies for outputs specified by the
4287 same method. If only `crate_type` attributes are specified, then they will all
4288 be built, but if one or more `--crate-type` command line flag is specified,
4289 then only those outputs will be built.
4291 With all these different kinds of outputs, if crate A depends on crate B, then
4292 the compiler could find B in various different forms throughout the system. The
4293 only forms looked for by the compiler, however, are the `rlib` format and the
4294 dynamic library format. With these two options for a dependent library, the
4295 compiler must at some point make a choice between these two formats. With this
4296 in mind, the compiler follows these rules when determining what format of
4297 dependencies will be used:
4299 1. If a static library is being produced, all upstream dependencies are
4300 required to be available in `rlib` formats. This requirement stems from the
4301 reason that a dynamic library cannot be converted into a static format.
4303 Note that it is impossible to link in native dynamic dependencies to a static
4304 library, and in this case warnings will be printed about all unlinked native
4305 dynamic dependencies.
4307 2. If an `rlib` file is being produced, then there are no restrictions on what
4308 format the upstream dependencies are available in. It is simply required that
4309 all upstream dependencies be available for reading metadata from.
4311 The reason for this is that `rlib` files do not contain any of their upstream
4312 dependencies. It wouldn't be very efficient for all `rlib` files to contain a
4313 copy of `libstd.rlib`!
4315 3. If an executable is being produced and the `-C prefer-dynamic` flag is not
4316 specified, then dependencies are first attempted to be found in the `rlib`
4317 format. If some dependencies are not available in an rlib format, then
4318 dynamic linking is attempted (see below).
4320 4. If a dynamic library or an executable that is being dynamically linked is
4321 being produced, then the compiler will attempt to reconcile the available
4322 dependencies in either the rlib or dylib format to create a final product.
4324 A major goal of the compiler is to ensure that a library never appears more
4325 than once in any artifact. For example, if dynamic libraries B and C were
4326 each statically linked to library A, then a crate could not link to B and C
4327 together because there would be two copies of A. The compiler allows mixing
4328 the rlib and dylib formats, but this restriction must be satisfied.
4330 The compiler currently implements no method of hinting what format a library
4331 should be linked with. When dynamically linking, the compiler will attempt to
4332 maximize dynamic dependencies while still allowing some dependencies to be
4333 linked in via an rlib.
4335 For most situations, having all libraries available as a dylib is recommended
4336 if dynamically linking. For other situations, the compiler will emit a
4337 warning if it is unable to determine which formats to link each library with.
4339 In general, `--crate-type=bin` or `--crate-type=lib` should be sufficient for
4340 all compilation needs, and the other options are just available if more
4341 fine-grained control is desired over the output format of a Rust crate.
4343 # Appendix: Rationales and design tradeoffs
4347 # Appendix: Influences
4349 Rust is not a particularly original language, with design elements coming from
4350 a wide range of sources. Some of these are listed below (including elements
4351 that have since been removed):
4353 * SML, OCaml: algebraic datatypes, pattern matching, type inference,
4354 semicolon statement separation
4355 * C++: references, RAII, smart pointers, move semantics, monomorphisation,
4357 * ML Kit, Cyclone: region based memory management
4358 * Haskell (GHC): typeclasses, type families
4359 * Newsqueak, Alef, Limbo: channels, concurrency
4360 * Erlang: message passing, task failure, ~~linked task failure~~,
4361 ~~lightweight concurrency~~
4362 * Swift: optional bindings
4363 * Scheme: hygienic macros
4365 * Ruby: ~~block syntax~~
4366 * NIL, Hermes: ~~typestate~~
4367 * [Unicode Annex #31](http://www.unicode.org/reports/tr31/): identifier and
4370 [ffi]: book/ffi.html
4371 [plugin]: book/plugin.html