]> git.lizzy.rs Git - rust.git/blob - src/librustc/diagnostics.rs
Rollup merge of #57368 - petrhosek:cmake-compiler-launcher, r=alexcrichton
[rust.git] / src / librustc / diagnostics.rs
1 #![allow(non_snake_case)]
2
3 // Error messages for EXXXX errors.
4 // Each message should start and end with a new line, and be wrapped to 80 characters.
5 // In vim you can `:set tw=80` and use `gq` to wrap paragraphs. Use `:set tw=0` to disable.
6 register_long_diagnostics! {
7 E0038: r##"
8 Trait objects like `Box<Trait>` can only be constructed when certain
9 requirements are satisfied by the trait in question.
10
11 Trait objects are a form of dynamic dispatch and use a dynamically sized type
12 for the inner type. So, for a given trait `Trait`, when `Trait` is treated as a
13 type, as in `Box<Trait>`, the inner type is 'unsized'. In such cases the boxed
14 pointer is a 'fat pointer' that contains an extra pointer to a table of methods
15 (among other things) for dynamic dispatch. This design mandates some
16 restrictions on the types of traits that are allowed to be used in trait
17 objects, which are collectively termed as 'object safety' rules.
18
19 Attempting to create a trait object for a non object-safe trait will trigger
20 this error.
21
22 There are various rules:
23
24 ### The trait cannot require `Self: Sized`
25
26 When `Trait` is treated as a type, the type does not implement the special
27 `Sized` trait, because the type does not have a known size at compile time and
28 can only be accessed behind a pointer. Thus, if we have a trait like the
29 following:
30
31 ```
32 trait Foo where Self: Sized {
33
34 }
35 ```
36
37 We cannot create an object of type `Box<Foo>` or `&Foo` since in this case
38 `Self` would not be `Sized`.
39
40 Generally, `Self: Sized` is used to indicate that the trait should not be used
41 as a trait object. If the trait comes from your own crate, consider removing
42 this restriction.
43
44 ### Method references the `Self` type in its arguments or return type
45
46 This happens when a trait has a method like the following:
47
48 ```
49 trait Trait {
50     fn foo(&self) -> Self;
51 }
52
53 impl Trait for String {
54     fn foo(&self) -> Self {
55         "hi".to_owned()
56     }
57 }
58
59 impl Trait for u8 {
60     fn foo(&self) -> Self {
61         1
62     }
63 }
64 ```
65
66 (Note that `&self` and `&mut self` are okay, it's additional `Self` types which
67 cause this problem.)
68
69 In such a case, the compiler cannot predict the return type of `foo()` in a
70 situation like the following:
71
72 ```compile_fail
73 trait Trait {
74     fn foo(&self) -> Self;
75 }
76
77 fn call_foo(x: Box<Trait>) {
78     let y = x.foo(); // What type is y?
79     // ...
80 }
81 ```
82
83 If only some methods aren't object-safe, you can add a `where Self: Sized` bound
84 on them to mark them as explicitly unavailable to trait objects. The
85 functionality will still be available to all other implementers, including
86 `Box<Trait>` which is itself sized (assuming you `impl Trait for Box<Trait>`).
87
88 ```
89 trait Trait {
90     fn foo(&self) -> Self where Self: Sized;
91     // more functions
92 }
93 ```
94
95 Now, `foo()` can no longer be called on a trait object, but you will now be
96 allowed to make a trait object, and that will be able to call any object-safe
97 methods. With such a bound, one can still call `foo()` on types implementing
98 that trait that aren't behind trait objects.
99
100 ### Method has generic type parameters
101
102 As mentioned before, trait objects contain pointers to method tables. So, if we
103 have:
104
105 ```
106 trait Trait {
107     fn foo(&self);
108 }
109
110 impl Trait for String {
111     fn foo(&self) {
112         // implementation 1
113     }
114 }
115
116 impl Trait for u8 {
117     fn foo(&self) {
118         // implementation 2
119     }
120 }
121 // ...
122 ```
123
124 At compile time each implementation of `Trait` will produce a table containing
125 the various methods (and other items) related to the implementation.
126
127 This works fine, but when the method gains generic parameters, we can have a
128 problem.
129
130 Usually, generic parameters get _monomorphized_. For example, if I have
131
132 ```
133 fn foo<T>(x: T) {
134     // ...
135 }
136 ```
137
138 The machine code for `foo::<u8>()`, `foo::<bool>()`, `foo::<String>()`, or any
139 other type substitution is different. Hence the compiler generates the
140 implementation on-demand. If you call `foo()` with a `bool` parameter, the
141 compiler will only generate code for `foo::<bool>()`. When we have additional
142 type parameters, the number of monomorphized implementations the compiler
143 generates does not grow drastically, since the compiler will only generate an
144 implementation if the function is called with unparametrized substitutions
145 (i.e., substitutions where none of the substituted types are themselves
146 parametrized).
147
148 However, with trait objects we have to make a table containing _every_ object
149 that implements the trait. Now, if it has type parameters, we need to add
150 implementations for every type that implements the trait, and there could
151 theoretically be an infinite number of types.
152
153 For example, with:
154
155 ```
156 trait Trait {
157     fn foo<T>(&self, on: T);
158     // more methods
159 }
160
161 impl Trait for String {
162     fn foo<T>(&self, on: T) {
163         // implementation 1
164     }
165 }
166
167 impl Trait for u8 {
168     fn foo<T>(&self, on: T) {
169         // implementation 2
170     }
171 }
172
173 // 8 more implementations
174 ```
175
176 Now, if we have the following code:
177
178 ```compile_fail,E0038
179 # trait Trait { fn foo<T>(&self, on: T); }
180 # impl Trait for String { fn foo<T>(&self, on: T) {} }
181 # impl Trait for u8 { fn foo<T>(&self, on: T) {} }
182 # impl Trait for bool { fn foo<T>(&self, on: T) {} }
183 # // etc.
184 fn call_foo(thing: Box<Trait>) {
185     thing.foo(true); // this could be any one of the 8 types above
186     thing.foo(1);
187     thing.foo("hello");
188 }
189 ```
190
191 We don't just need to create a table of all implementations of all methods of
192 `Trait`, we need to create such a table, for each different type fed to
193 `foo()`. In this case this turns out to be (10 types implementing `Trait`)*(3
194 types being fed to `foo()`) = 30 implementations!
195
196 With real world traits these numbers can grow drastically.
197
198 To fix this, it is suggested to use a `where Self: Sized` bound similar to the
199 fix for the sub-error above if you do not intend to call the method with type
200 parameters:
201
202 ```
203 trait Trait {
204     fn foo<T>(&self, on: T) where Self: Sized;
205     // more methods
206 }
207 ```
208
209 If this is not an option, consider replacing the type parameter with another
210 trait object (e.g., if `T: OtherTrait`, use `on: Box<OtherTrait>`). If the
211 number of types you intend to feed to this method is limited, consider manually
212 listing out the methods of different types.
213
214 ### Method has no receiver
215
216 Methods that do not take a `self` parameter can't be called since there won't be
217 a way to get a pointer to the method table for them.
218
219 ```
220 trait Foo {
221     fn foo() -> u8;
222 }
223 ```
224
225 This could be called as `<Foo as Foo>::foo()`, which would not be able to pick
226 an implementation.
227
228 Adding a `Self: Sized` bound to these methods will generally make this compile.
229
230 ```
231 trait Foo {
232     fn foo() -> u8 where Self: Sized;
233 }
234 ```
235
236 ### The trait cannot contain associated constants
237
238 Just like static functions, associated constants aren't stored on the method
239 table. If the trait or any subtrait contain an associated constant, they cannot
240 be made into an object.
241
242 ```compile_fail,E0038
243 trait Foo {
244     const X: i32;
245 }
246
247 impl Foo {}
248 ```
249
250 A simple workaround is to use a helper method instead:
251
252 ```
253 trait Foo {
254     fn x(&self) -> i32;
255 }
256 ```
257
258 ### The trait cannot use `Self` as a type parameter in the supertrait listing
259
260 This is similar to the second sub-error, but subtler. It happens in situations
261 like the following:
262
263 ```compile_fail
264 trait Super<A> {}
265
266 trait Trait: Super<Self> {
267 }
268
269 struct Foo;
270
271 impl Super<Foo> for Foo{}
272
273 impl Trait for Foo {}
274 ```
275
276 Here, the supertrait might have methods as follows:
277
278 ```
279 trait Super<A> {
280     fn get_a(&self) -> A; // note that this is object safe!
281 }
282 ```
283
284 If the trait `Foo` was deriving from something like `Super<String>` or
285 `Super<T>` (where `Foo` itself is `Foo<T>`), this is okay, because given a type
286 `get_a()` will definitely return an object of that type.
287
288 However, if it derives from `Super<Self>`, even though `Super` is object safe,
289 the method `get_a()` would return an object of unknown type when called on the
290 function. `Self` type parameters let us make object safe traits no longer safe,
291 so they are forbidden when specifying supertraits.
292
293 There's no easy fix for this, generally code will need to be refactored so that
294 you no longer need to derive from `Super<Self>`.
295 "##,
296
297 E0072: r##"
298 When defining a recursive struct or enum, any use of the type being defined
299 from inside the definition must occur behind a pointer (like `Box` or `&`).
300 This is because structs and enums must have a well-defined size, and without
301 the pointer, the size of the type would need to be unbounded.
302
303 Consider the following erroneous definition of a type for a list of bytes:
304
305 ```compile_fail,E0072
306 // error, invalid recursive struct type
307 struct ListNode {
308     head: u8,
309     tail: Option<ListNode>,
310 }
311 ```
312
313 This type cannot have a well-defined size, because it needs to be arbitrarily
314 large (since we would be able to nest `ListNode`s to any depth). Specifically,
315
316 ```plain
317 size of `ListNode` = 1 byte for `head`
318                    + 1 byte for the discriminant of the `Option`
319                    + size of `ListNode`
320 ```
321
322 One way to fix this is by wrapping `ListNode` in a `Box`, like so:
323
324 ```
325 struct ListNode {
326     head: u8,
327     tail: Option<Box<ListNode>>,
328 }
329 ```
330
331 This works because `Box` is a pointer, so its size is well-known.
332 "##,
333
334 E0080: r##"
335 This error indicates that the compiler was unable to sensibly evaluate an
336 constant expression that had to be evaluated. Attempting to divide by 0
337 or causing integer overflow are two ways to induce this error. For example:
338
339 ```compile_fail,E0080
340 enum Enum {
341     X = (1 << 500),
342     Y = (1 / 0)
343 }
344 ```
345
346 Ensure that the expressions given can be evaluated as the desired integer type.
347 See the FFI section of the Reference for more information about using a custom
348 integer type:
349
350 https://doc.rust-lang.org/reference.html#ffi-attributes
351 "##,
352
353 E0106: r##"
354 This error indicates that a lifetime is missing from a type. If it is an error
355 inside a function signature, the problem may be with failing to adhere to the
356 lifetime elision rules (see below).
357
358 Here are some simple examples of where you'll run into this error:
359
360 ```compile_fail,E0106
361 struct Foo1 { x: &bool }
362               // ^ expected lifetime parameter
363 struct Foo2<'a> { x: &'a bool } // correct
364
365 struct Bar1 { x: Foo2 }
366               // ^^^^ expected lifetime parameter
367 struct Bar2<'a> { x: Foo2<'a> } // correct
368
369 enum Baz1 { A(u8), B(&bool), }
370                   // ^ expected lifetime parameter
371 enum Baz2<'a> { A(u8), B(&'a bool), } // correct
372
373 type MyStr1 = &str;
374            // ^ expected lifetime parameter
375 type MyStr2<'a> = &'a str; // correct
376 ```
377
378 Lifetime elision is a special, limited kind of inference for lifetimes in
379 function signatures which allows you to leave out lifetimes in certain cases.
380 For more background on lifetime elision see [the book][book-le].
381
382 The lifetime elision rules require that any function signature with an elided
383 output lifetime must either have
384
385  - exactly one input lifetime
386  - or, multiple input lifetimes, but the function must also be a method with a
387    `&self` or `&mut self` receiver
388
389 In the first case, the output lifetime is inferred to be the same as the unique
390 input lifetime. In the second case, the lifetime is instead inferred to be the
391 same as the lifetime on `&self` or `&mut self`.
392
393 Here are some examples of elision errors:
394
395 ```compile_fail,E0106
396 // error, no input lifetimes
397 fn foo() -> &str { }
398
399 // error, `x` and `y` have distinct lifetimes inferred
400 fn bar(x: &str, y: &str) -> &str { }
401
402 // error, `y`'s lifetime is inferred to be distinct from `x`'s
403 fn baz<'a>(x: &'a str, y: &str) -> &str { }
404 ```
405
406 Lifetime elision in implementation headers was part of the lifetime elision
407 RFC. It is, however, [currently unimplemented][iss15872].
408
409 [book-le]: https://doc.rust-lang.org/nightly/book/first-edition/lifetimes.html#lifetime-elision
410 [iss15872]: https://github.com/rust-lang/rust/issues/15872
411 "##,
412
413 E0119: r##"
414 There are conflicting trait implementations for the same type.
415 Example of erroneous code:
416
417 ```compile_fail,E0119
418 trait MyTrait {
419     fn get(&self) -> usize;
420 }
421
422 impl<T> MyTrait for T {
423     fn get(&self) -> usize { 0 }
424 }
425
426 struct Foo {
427     value: usize
428 }
429
430 impl MyTrait for Foo { // error: conflicting implementations of trait
431                        //        `MyTrait` for type `Foo`
432     fn get(&self) -> usize { self.value }
433 }
434 ```
435
436 When looking for the implementation for the trait, the compiler finds
437 both the `impl<T> MyTrait for T` where T is all types and the `impl
438 MyTrait for Foo`. Since a trait cannot be implemented multiple times,
439 this is an error. So, when you write:
440
441 ```
442 trait MyTrait {
443     fn get(&self) -> usize;
444 }
445
446 impl<T> MyTrait for T {
447     fn get(&self) -> usize { 0 }
448 }
449 ```
450
451 This makes the trait implemented on all types in the scope. So if you
452 try to implement it on another one after that, the implementations will
453 conflict. Example:
454
455 ```
456 trait MyTrait {
457     fn get(&self) -> usize;
458 }
459
460 impl<T> MyTrait for T {
461     fn get(&self) -> usize { 0 }
462 }
463
464 struct Foo;
465
466 fn main() {
467     let f = Foo;
468
469     f.get(); // the trait is implemented so we can use it
470 }
471 ```
472 "##,
473
474 // This shouldn't really ever trigger since the repeated value error comes first
475 E0136: r##"
476 A binary can only have one entry point, and by default that entry point is the
477 function `main()`. If there are multiple such functions, please rename one.
478 "##,
479
480 E0137: r##"
481 More than one function was declared with the `#[main]` attribute.
482
483 Erroneous code example:
484
485 ```compile_fail,E0137
486 #![feature(main)]
487
488 #[main]
489 fn foo() {}
490
491 #[main]
492 fn f() {} // error: multiple functions with a #[main] attribute
493 ```
494
495 This error indicates that the compiler found multiple functions with the
496 `#[main]` attribute. This is an error because there must be a unique entry
497 point into a Rust program. Example:
498
499 ```
500 #![feature(main)]
501
502 #[main]
503 fn f() {} // ok!
504 ```
505 "##,
506
507 E0138: r##"
508 More than one function was declared with the `#[start]` attribute.
509
510 Erroneous code example:
511
512 ```compile_fail,E0138
513 #![feature(start)]
514
515 #[start]
516 fn foo(argc: isize, argv: *const *const u8) -> isize {}
517
518 #[start]
519 fn f(argc: isize, argv: *const *const u8) -> isize {}
520 // error: multiple 'start' functions
521 ```
522
523 This error indicates that the compiler found multiple functions with the
524 `#[start]` attribute. This is an error because there must be a unique entry
525 point into a Rust program. Example:
526
527 ```
528 #![feature(start)]
529
530 #[start]
531 fn foo(argc: isize, argv: *const *const u8) -> isize { 0 } // ok!
532 ```
533 "##,
534
535 E0139: r##"
536 #### Note: this error code is no longer emitted by the compiler.
537
538 There are various restrictions on transmuting between types in Rust; for example
539 types being transmuted must have the same size. To apply all these restrictions,
540 the compiler must know the exact types that may be transmuted. When type
541 parameters are involved, this cannot always be done.
542
543 So, for example, the following is not allowed:
544
545 ```
546 use std::mem::transmute;
547
548 struct Foo<T>(Vec<T>);
549
550 fn foo<T>(x: Vec<T>) {
551     // we are transmuting between Vec<T> and Foo<F> here
552     let y: Foo<T> = unsafe { transmute(x) };
553     // do something with y
554 }
555 ```
556
557 In this specific case there's a good chance that the transmute is harmless (but
558 this is not guaranteed by Rust). However, when alignment and enum optimizations
559 come into the picture, it's quite likely that the sizes may or may not match
560 with different type parameter substitutions. It's not possible to check this for
561 _all_ possible types, so `transmute()` simply only accepts types without any
562 unsubstituted type parameters.
563
564 If you need this, there's a good chance you're doing something wrong. Keep in
565 mind that Rust doesn't guarantee much about the layout of different structs
566 (even two structs with identical declarations may have different layouts). If
567 there is a solution that avoids the transmute entirely, try it instead.
568
569 If it's possible, hand-monomorphize the code by writing the function for each
570 possible type substitution. It's possible to use traits to do this cleanly,
571 for example:
572
573 ```
574 use std::mem::transmute;
575
576 struct Foo<T>(Vec<T>);
577
578 trait MyTransmutableType: Sized {
579     fn transmute(_: Vec<Self>) -> Foo<Self>;
580 }
581
582 impl MyTransmutableType for u8 {
583     fn transmute(x: Vec<u8>) -> Foo<u8> {
584         unsafe { transmute(x) }
585     }
586 }
587
588 impl MyTransmutableType for String {
589     fn transmute(x: Vec<String>) -> Foo<String> {
590         unsafe { transmute(x) }
591     }
592 }
593
594 // ... more impls for the types you intend to transmute
595
596 fn foo<T: MyTransmutableType>(x: Vec<T>) {
597     let y: Foo<T> = <T as MyTransmutableType>::transmute(x);
598     // do something with y
599 }
600 ```
601
602 Each impl will be checked for a size match in the transmute as usual, and since
603 there are no unbound type parameters involved, this should compile unless there
604 is a size mismatch in one of the impls.
605
606 It is also possible to manually transmute:
607
608 ```
609 # use std::ptr;
610 # let v = Some("value");
611 # type SomeType = &'static [u8];
612 unsafe {
613     ptr::read(&v as *const _ as *const SomeType) // `v` transmuted to `SomeType`
614 }
615 # ;
616 ```
617
618 Note that this does not move `v` (unlike `transmute`), and may need a
619 call to `mem::forget(v)` in case you want to avoid destructors being called.
620 "##,
621
622 E0152: r##"
623 A lang item was redefined.
624
625 Erroneous code example:
626
627 ```compile_fail,E0152
628 #![feature(lang_items)]
629
630 #[lang = "arc"]
631 struct Foo; // error: duplicate lang item found: `arc`
632 ```
633
634 Lang items are already implemented in the standard library. Unless you are
635 writing a free-standing application (e.g., a kernel), you do not need to provide
636 them yourself.
637
638 You can build a free-standing crate by adding `#![no_std]` to the crate
639 attributes:
640
641 ```ignore (only-for-syntax-highlight)
642 #![no_std]
643 ```
644
645 See also https://doc.rust-lang.org/book/first-edition/no-stdlib.html
646 "##,
647
648 E0214: r##"
649 A generic type was described using parentheses rather than angle brackets.
650 For example:
651
652 ```compile_fail,E0214
653 fn main() {
654     let v: Vec(&str) = vec!["foo"];
655 }
656 ```
657
658 This is not currently supported: `v` should be defined as `Vec<&str>`.
659 Parentheses are currently only used with generic types when defining parameters
660 for `Fn`-family traits.
661 "##,
662
663 E0230: r##"
664 The `#[rustc_on_unimplemented]` attribute lets you specify a custom error
665 message for when a particular trait isn't implemented on a type placed in a
666 position that needs that trait. For example, when the following code is
667 compiled:
668
669 ```compile_fail
670 #![feature(on_unimplemented)]
671
672 fn foo<T: Index<u8>>(x: T){}
673
674 #[rustc_on_unimplemented = "the type `{Self}` cannot be indexed by `{Idx}`"]
675 trait Index<Idx> { /* ... */ }
676
677 foo(true); // `bool` does not implement `Index<u8>`
678 ```
679
680 There will be an error about `bool` not implementing `Index<u8>`, followed by a
681 note saying "the type `bool` cannot be indexed by `u8`".
682
683 As you can see, you can specify type parameters in curly braces for
684 substitution with the actual types (using the regular format string syntax) in
685 a given situation. Furthermore, `{Self}` will substitute to the type (in this
686 case, `bool`) that we tried to use.
687
688 This error appears when the curly braces contain an identifier which doesn't
689 match with any of the type parameters or the string `Self`. This might happen
690 if you misspelled a type parameter, or if you intended to use literal curly
691 braces. If it is the latter, escape the curly braces with a second curly brace
692 of the same type; e.g., a literal `{` is `{{`.
693 "##,
694
695 E0231: r##"
696 The `#[rustc_on_unimplemented]` attribute lets you specify a custom error
697 message for when a particular trait isn't implemented on a type placed in a
698 position that needs that trait. For example, when the following code is
699 compiled:
700
701 ```compile_fail
702 #![feature(on_unimplemented)]
703
704 fn foo<T: Index<u8>>(x: T){}
705
706 #[rustc_on_unimplemented = "the type `{Self}` cannot be indexed by `{Idx}`"]
707 trait Index<Idx> { /* ... */ }
708
709 foo(true); // `bool` does not implement `Index<u8>`
710 ```
711
712 there will be an error about `bool` not implementing `Index<u8>`, followed by a
713 note saying "the type `bool` cannot be indexed by `u8`".
714
715 As you can see, you can specify type parameters in curly braces for
716 substitution with the actual types (using the regular format string syntax) in
717 a given situation. Furthermore, `{Self}` will substitute to the type (in this
718 case, `bool`) that we tried to use.
719
720 This error appears when the curly braces do not contain an identifier. Please
721 add one of the same name as a type parameter. If you intended to use literal
722 braces, use `{{` and `}}` to escape them.
723 "##,
724
725 E0232: r##"
726 The `#[rustc_on_unimplemented]` attribute lets you specify a custom error
727 message for when a particular trait isn't implemented on a type placed in a
728 position that needs that trait. For example, when the following code is
729 compiled:
730
731 ```compile_fail
732 #![feature(on_unimplemented)]
733
734 fn foo<T: Index<u8>>(x: T){}
735
736 #[rustc_on_unimplemented = "the type `{Self}` cannot be indexed by `{Idx}`"]
737 trait Index<Idx> { /* ... */ }
738
739 foo(true); // `bool` does not implement `Index<u8>`
740 ```
741
742 there will be an error about `bool` not implementing `Index<u8>`, followed by a
743 note saying "the type `bool` cannot be indexed by `u8`".
744
745 For this to work, some note must be specified. An empty attribute will not do
746 anything, please remove the attribute or add some helpful note for users of the
747 trait.
748 "##,
749
750 E0261: r##"
751 When using a lifetime like `'a` in a type, it must be declared before being
752 used.
753
754 These two examples illustrate the problem:
755
756 ```compile_fail,E0261
757 // error, use of undeclared lifetime name `'a`
758 fn foo(x: &'a str) { }
759
760 struct Foo {
761     // error, use of undeclared lifetime name `'a`
762     x: &'a str,
763 }
764 ```
765
766 These can be fixed by declaring lifetime parameters:
767
768 ```
769 fn foo<'a>(x: &'a str) {}
770
771 struct Foo<'a> {
772     x: &'a str,
773 }
774 ```
775 "##,
776
777 E0262: r##"
778 Declaring certain lifetime names in parameters is disallowed. For example,
779 because the `'static` lifetime is a special built-in lifetime name denoting
780 the lifetime of the entire program, this is an error:
781
782 ```compile_fail,E0262
783 // error, invalid lifetime parameter name `'static`
784 fn foo<'static>(x: &'static str) { }
785 ```
786 "##,
787
788 E0263: r##"
789 A lifetime name cannot be declared more than once in the same scope. For
790 example:
791
792 ```compile_fail,E0263
793 // error, lifetime name `'a` declared twice in the same scope
794 fn foo<'a, 'b, 'a>(x: &'a str, y: &'b str) { }
795 ```
796 "##,
797
798 E0264: r##"
799 An unknown external lang item was used. Erroneous code example:
800
801 ```compile_fail,E0264
802 #![feature(lang_items)]
803
804 extern "C" {
805     #[lang = "cake"] // error: unknown external lang item: `cake`
806     fn cake();
807 }
808 ```
809
810 A list of available external lang items is available in
811 `src/librustc/middle/weak_lang_items.rs`. Example:
812
813 ```
814 #![feature(lang_items)]
815
816 extern "C" {
817     #[lang = "panic_impl"] // ok!
818     fn cake();
819 }
820 ```
821 "##,
822
823 E0271: r##"
824 This is because of a type mismatch between the associated type of some
825 trait (e.g., `T::Bar`, where `T` implements `trait Quux { type Bar; }`)
826 and another type `U` that is required to be equal to `T::Bar`, but is not.
827 Examples follow.
828
829 Here is a basic example:
830
831 ```compile_fail,E0271
832 trait Trait { type AssociatedType; }
833
834 fn foo<T>(t: T) where T: Trait<AssociatedType=u32> {
835     println!("in foo");
836 }
837
838 impl Trait for i8 { type AssociatedType = &'static str; }
839
840 foo(3_i8);
841 ```
842
843 Here is that same example again, with some explanatory comments:
844
845 ```compile_fail,E0271
846 trait Trait { type AssociatedType; }
847
848 fn foo<T>(t: T) where T: Trait<AssociatedType=u32> {
849 //                    ~~~~~~~~ ~~~~~~~~~~~~~~~~~~
850 //                        |            |
851 //         This says `foo` can         |
852 //           only be used with         |
853 //              some type that         |
854 //         implements `Trait`.         |
855 //                                     |
856 //                             This says not only must
857 //                             `T` be an impl of `Trait`
858 //                             but also that the impl
859 //                             must assign the type `u32`
860 //                             to the associated type.
861     println!("in foo");
862 }
863
864 impl Trait for i8 { type AssociatedType = &'static str; }
865 //~~~~~~~~~~~~~~~   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
866 //      |                             |
867 // `i8` does have                     |
868 // implementation                     |
869 // of `Trait`...                      |
870 //                     ... but it is an implementation
871 //                     that assigns `&'static str` to
872 //                     the associated type.
873
874 foo(3_i8);
875 // Here, we invoke `foo` with an `i8`, which does not satisfy
876 // the constraint `<i8 as Trait>::AssociatedType=u32`, and
877 // therefore the type-checker complains with this error code.
878 ```
879
880 To avoid those issues, you have to make the types match correctly.
881 So we can fix the previous examples like this:
882
883 ```
884 // Basic Example:
885 trait Trait { type AssociatedType; }
886
887 fn foo<T>(t: T) where T: Trait<AssociatedType = &'static str> {
888     println!("in foo");
889 }
890
891 impl Trait for i8 { type AssociatedType = &'static str; }
892
893 foo(3_i8);
894
895 // For-Loop Example:
896 let vs = vec![1, 2, 3, 4];
897 for v in &vs {
898     match v {
899         &1 => {}
900         _ => {}
901     }
902 }
903 ```
904 "##,
905
906
907 E0275: r##"
908 This error occurs when there was a recursive trait requirement that overflowed
909 before it could be evaluated. Often this means that there is unbounded
910 recursion in resolving some type bounds.
911
912 For example, in the following code:
913
914 ```compile_fail,E0275
915 trait Foo {}
916
917 struct Bar<T>(T);
918
919 impl<T> Foo for T where Bar<T>: Foo {}
920 ```
921
922 To determine if a `T` is `Foo`, we need to check if `Bar<T>` is `Foo`. However,
923 to do this check, we need to determine that `Bar<Bar<T>>` is `Foo`. To
924 determine this, we check if `Bar<Bar<Bar<T>>>` is `Foo`, and so on. This is
925 clearly a recursive requirement that can't be resolved directly.
926
927 Consider changing your trait bounds so that they're less self-referential.
928 "##,
929
930 E0276: r##"
931 This error occurs when a bound in an implementation of a trait does not match
932 the bounds specified in the original trait. For example:
933
934 ```compile_fail,E0276
935 trait Foo {
936     fn foo<T>(x: T);
937 }
938
939 impl Foo for bool {
940     fn foo<T>(x: T) where T: Copy {}
941 }
942 ```
943
944 Here, all types implementing `Foo` must have a method `foo<T>(x: T)` which can
945 take any type `T`. However, in the `impl` for `bool`, we have added an extra
946 bound that `T` is `Copy`, which isn't compatible with the original trait.
947
948 Consider removing the bound from the method or adding the bound to the original
949 method definition in the trait.
950 "##,
951
952 E0277: r##"
953 You tried to use a type which doesn't implement some trait in a place which
954 expected that trait. Erroneous code example:
955
956 ```compile_fail,E0277
957 // here we declare the Foo trait with a bar method
958 trait Foo {
959     fn bar(&self);
960 }
961
962 // we now declare a function which takes an object implementing the Foo trait
963 fn some_func<T: Foo>(foo: T) {
964     foo.bar();
965 }
966
967 fn main() {
968     // we now call the method with the i32 type, which doesn't implement
969     // the Foo trait
970     some_func(5i32); // error: the trait bound `i32 : Foo` is not satisfied
971 }
972 ```
973
974 In order to fix this error, verify that the type you're using does implement
975 the trait. Example:
976
977 ```
978 trait Foo {
979     fn bar(&self);
980 }
981
982 fn some_func<T: Foo>(foo: T) {
983     foo.bar(); // we can now use this method since i32 implements the
984                // Foo trait
985 }
986
987 // we implement the trait on the i32 type
988 impl Foo for i32 {
989     fn bar(&self) {}
990 }
991
992 fn main() {
993     some_func(5i32); // ok!
994 }
995 ```
996
997 Or in a generic context, an erroneous code example would look like:
998
999 ```compile_fail,E0277
1000 fn some_func<T>(foo: T) {
1001     println!("{:?}", foo); // error: the trait `core::fmt::Debug` is not
1002                            //        implemented for the type `T`
1003 }
1004
1005 fn main() {
1006     // We now call the method with the i32 type,
1007     // which *does* implement the Debug trait.
1008     some_func(5i32);
1009 }
1010 ```
1011
1012 Note that the error here is in the definition of the generic function: Although
1013 we only call it with a parameter that does implement `Debug`, the compiler
1014 still rejects the function: It must work with all possible input types. In
1015 order to make this example compile, we need to restrict the generic type we're
1016 accepting:
1017
1018 ```
1019 use std::fmt;
1020
1021 // Restrict the input type to types that implement Debug.
1022 fn some_func<T: fmt::Debug>(foo: T) {
1023     println!("{:?}", foo);
1024 }
1025
1026 fn main() {
1027     // Calling the method is still fine, as i32 implements Debug.
1028     some_func(5i32);
1029
1030     // This would fail to compile now:
1031     // struct WithoutDebug;
1032     // some_func(WithoutDebug);
1033 }
1034 ```
1035
1036 Rust only looks at the signature of the called function, as such it must
1037 already specify all requirements that will be used for every type parameter.
1038 "##,
1039
1040 E0281: r##"
1041 #### Note: this error code is no longer emitted by the compiler.
1042
1043 You tried to supply a type which doesn't implement some trait in a location
1044 which expected that trait. This error typically occurs when working with
1045 `Fn`-based types. Erroneous code example:
1046
1047 ```compile-fail
1048 fn foo<F: Fn(usize)>(x: F) { }
1049
1050 fn main() {
1051     // type mismatch: ... implements the trait `core::ops::Fn<(String,)>`,
1052     // but the trait `core::ops::Fn<(usize,)>` is required
1053     // [E0281]
1054     foo(|y: String| { });
1055 }
1056 ```
1057
1058 The issue in this case is that `foo` is defined as accepting a `Fn` with one
1059 argument of type `String`, but the closure we attempted to pass to it requires
1060 one arguments of type `usize`.
1061 "##,
1062
1063 E0282: r##"
1064 This error indicates that type inference did not result in one unique possible
1065 type, and extra information is required. In most cases this can be provided
1066 by adding a type annotation. Sometimes you need to specify a generic type
1067 parameter manually.
1068
1069 A common example is the `collect` method on `Iterator`. It has a generic type
1070 parameter with a `FromIterator` bound, which for a `char` iterator is
1071 implemented by `Vec` and `String` among others. Consider the following snippet
1072 that reverses the characters of a string:
1073
1074 ```compile_fail,E0282
1075 let x = "hello".chars().rev().collect();
1076 ```
1077
1078 In this case, the compiler cannot infer what the type of `x` should be:
1079 `Vec<char>` and `String` are both suitable candidates. To specify which type to
1080 use, you can use a type annotation on `x`:
1081
1082 ```
1083 let x: Vec<char> = "hello".chars().rev().collect();
1084 ```
1085
1086 It is not necessary to annotate the full type. Once the ambiguity is resolved,
1087 the compiler can infer the rest:
1088
1089 ```
1090 let x: Vec<_> = "hello".chars().rev().collect();
1091 ```
1092
1093 Another way to provide the compiler with enough information, is to specify the
1094 generic type parameter:
1095
1096 ```
1097 let x = "hello".chars().rev().collect::<Vec<char>>();
1098 ```
1099
1100 Again, you need not specify the full type if the compiler can infer it:
1101
1102 ```
1103 let x = "hello".chars().rev().collect::<Vec<_>>();
1104 ```
1105
1106 Apart from a method or function with a generic type parameter, this error can
1107 occur when a type parameter of a struct or trait cannot be inferred. In that
1108 case it is not always possible to use a type annotation, because all candidates
1109 have the same return type. For instance:
1110
1111 ```compile_fail,E0282
1112 struct Foo<T> {
1113     num: T,
1114 }
1115
1116 impl<T> Foo<T> {
1117     fn bar() -> i32 {
1118         0
1119     }
1120
1121     fn baz() {
1122         let number = Foo::bar();
1123     }
1124 }
1125 ```
1126
1127 This will fail because the compiler does not know which instance of `Foo` to
1128 call `bar` on. Change `Foo::bar()` to `Foo::<T>::bar()` to resolve the error.
1129 "##,
1130
1131 E0283: r##"
1132 This error occurs when the compiler doesn't have enough information
1133 to unambiguously choose an implementation.
1134
1135 For example:
1136
1137 ```compile_fail,E0283
1138 trait Generator {
1139     fn create() -> u32;
1140 }
1141
1142 struct Impl;
1143
1144 impl Generator for Impl {
1145     fn create() -> u32 { 1 }
1146 }
1147
1148 struct AnotherImpl;
1149
1150 impl Generator for AnotherImpl {
1151     fn create() -> u32 { 2 }
1152 }
1153
1154 fn main() {
1155     let cont: u32 = Generator::create();
1156     // error, impossible to choose one of Generator trait implementation
1157     // Impl or AnotherImpl? Maybe anything else?
1158 }
1159 ```
1160
1161 To resolve this error use the concrete type:
1162
1163 ```
1164 trait Generator {
1165     fn create() -> u32;
1166 }
1167
1168 struct AnotherImpl;
1169
1170 impl Generator for AnotherImpl {
1171     fn create() -> u32 { 2 }
1172 }
1173
1174 fn main() {
1175     let gen1 = AnotherImpl::create();
1176
1177     // if there are multiple methods with same name (different traits)
1178     let gen2 = <AnotherImpl as Generator>::create();
1179 }
1180 ```
1181 "##,
1182
1183 E0296: r##"
1184 This error indicates that the given recursion limit could not be parsed. Ensure
1185 that the value provided is a positive integer between quotes.
1186
1187 Erroneous code example:
1188
1189 ```compile_fail,E0296
1190 #![recursion_limit]
1191
1192 fn main() {}
1193 ```
1194
1195 And a working example:
1196
1197 ```
1198 #![recursion_limit="1000"]
1199
1200 fn main() {}
1201 ```
1202 "##,
1203
1204 E0308: r##"
1205 This error occurs when the compiler was unable to infer the concrete type of a
1206 variable. It can occur for several cases, the most common of which is a
1207 mismatch in the expected type that the compiler inferred for a variable's
1208 initializing expression, and the actual type explicitly assigned to the
1209 variable.
1210
1211 For example:
1212
1213 ```compile_fail,E0308
1214 let x: i32 = "I am not a number!";
1215 //     ~~~   ~~~~~~~~~~~~~~~~~~~~
1216 //      |             |
1217 //      |    initializing expression;
1218 //      |    compiler infers type `&str`
1219 //      |
1220 //    type `i32` assigned to variable `x`
1221 ```
1222 "##,
1223
1224 E0309: r##"
1225 The type definition contains some field whose type
1226 requires an outlives annotation. Outlives annotations
1227 (e.g., `T: 'a`) are used to guarantee that all the data in T is valid
1228 for at least the lifetime `'a`. This scenario most commonly
1229 arises when the type contains an associated type reference
1230 like `<T as SomeTrait<'a>>::Output`, as shown in this example:
1231
1232 ```compile_fail,E0309
1233 // This won't compile because the applicable impl of
1234 // `SomeTrait` (below) requires that `T: 'a`, but the struct does
1235 // not have a matching where-clause.
1236 struct Foo<'a, T> {
1237     foo: <T as SomeTrait<'a>>::Output,
1238 }
1239
1240 trait SomeTrait<'a> {
1241     type Output;
1242 }
1243
1244 impl<'a, T> SomeTrait<'a> for T
1245 where
1246     T: 'a,
1247 {
1248     type Output = u32;
1249 }
1250 ```
1251
1252 Here, the where clause `T: 'a` that appears on the impl is not known to be
1253 satisfied on the struct. To make this example compile, you have to add
1254 a where-clause like `T: 'a` to the struct definition:
1255
1256 ```
1257 struct Foo<'a, T>
1258 where
1259     T: 'a,
1260 {
1261     foo: <T as SomeTrait<'a>>::Output
1262 }
1263
1264 trait SomeTrait<'a> {
1265     type Output;
1266 }
1267
1268 impl<'a, T> SomeTrait<'a> for T
1269 where
1270     T: 'a,
1271 {
1272     type Output = u32;
1273 }
1274 ```
1275 "##,
1276
1277 E0310: r##"
1278 Types in type definitions have lifetimes associated with them that represent
1279 how long the data stored within them is guaranteed to be live. This lifetime
1280 must be as long as the data needs to be alive, and missing the constraint that
1281 denotes this will cause this error.
1282
1283 ```compile_fail,E0310
1284 // This won't compile because T is not constrained to the static lifetime
1285 // the reference needs
1286 struct Foo<T> {
1287     foo: &'static T
1288 }
1289 ```
1290
1291 This will compile, because it has the constraint on the type parameter:
1292
1293 ```
1294 struct Foo<T: 'static> {
1295     foo: &'static T
1296 }
1297 ```
1298 "##,
1299
1300 E0317: r##"
1301 This error occurs when an `if` expression without an `else` block is used in a
1302 context where a type other than `()` is expected, for example a `let`
1303 expression:
1304
1305 ```compile_fail,E0317
1306 fn main() {
1307     let x = 5;
1308     let a = if x == 5 { 1 };
1309 }
1310 ```
1311
1312 An `if` expression without an `else` block has the type `()`, so this is a type
1313 error. To resolve it, add an `else` block having the same type as the `if`
1314 block.
1315 "##,
1316
1317 E0391: r##"
1318 This error indicates that some types or traits depend on each other
1319 and therefore cannot be constructed.
1320
1321 The following example contains a circular dependency between two traits:
1322
1323 ```compile_fail,E0391
1324 trait FirstTrait : SecondTrait {
1325
1326 }
1327
1328 trait SecondTrait : FirstTrait {
1329
1330 }
1331 ```
1332 "##,
1333
1334 E0398: r##"
1335 #### Note: this error code is no longer emitted by the compiler.
1336
1337 In Rust 1.3, the default object lifetime bounds are expected to change, as
1338 described in [RFC 1156]. You are getting a warning because the compiler
1339 thinks it is possible that this change will cause a compilation error in your
1340 code. It is possible, though unlikely, that this is a false alarm.
1341
1342 The heart of the change is that where `&'a Box<SomeTrait>` used to default to
1343 `&'a Box<SomeTrait+'a>`, it now defaults to `&'a Box<SomeTrait+'static>` (here,
1344 `SomeTrait` is the name of some trait type). Note that the only types which are
1345 affected are references to boxes, like `&Box<SomeTrait>` or
1346 `&[Box<SomeTrait>]`. More common types like `&SomeTrait` or `Box<SomeTrait>`
1347 are unaffected.
1348
1349 To silence this warning, edit your code to use an explicit bound. Most of the
1350 time, this means that you will want to change the signature of a function that
1351 you are calling. For example, if the error is reported on a call like `foo(x)`,
1352 and `foo` is defined as follows:
1353
1354 ```
1355 # trait SomeTrait {}
1356 fn foo(arg: &Box<SomeTrait>) { /* ... */ }
1357 ```
1358
1359 You might change it to:
1360
1361 ```
1362 # trait SomeTrait {}
1363 fn foo<'a>(arg: &'a Box<SomeTrait+'a>) { /* ... */ }
1364 ```
1365
1366 This explicitly states that you expect the trait object `SomeTrait` to contain
1367 references (with a maximum lifetime of `'a`).
1368
1369 [RFC 1156]: https://github.com/rust-lang/rfcs/blob/master/text/1156-adjust-default-object-bounds.md
1370 "##,
1371
1372 E0452: r##"
1373 An invalid lint attribute has been given. Erroneous code example:
1374
1375 ```compile_fail,E0452
1376 #![allow(foo = "")] // error: malformed lint attribute
1377 ```
1378
1379 Lint attributes only accept a list of identifiers (where each identifier is a
1380 lint name). Ensure the attribute is of this form:
1381
1382 ```
1383 #![allow(foo)] // ok!
1384 // or:
1385 #![allow(foo, foo2)] // ok!
1386 ```
1387 "##,
1388
1389 E0453: r##"
1390 A lint check attribute was overruled by a `forbid` directive set as an
1391 attribute on an enclosing scope, or on the command line with the `-F` option.
1392
1393 Example of erroneous code:
1394
1395 ```compile_fail,E0453
1396 #![forbid(non_snake_case)]
1397
1398 #[allow(non_snake_case)]
1399 fn main() {
1400     let MyNumber = 2; // error: allow(non_snake_case) overruled by outer
1401                       //        forbid(non_snake_case)
1402 }
1403 ```
1404
1405 The `forbid` lint setting, like `deny`, turns the corresponding compiler
1406 warning into a hard error. Unlike `deny`, `forbid` prevents itself from being
1407 overridden by inner attributes.
1408
1409 If you're sure you want to override the lint check, you can change `forbid` to
1410 `deny` (or use `-D` instead of `-F` if the `forbid` setting was given as a
1411 command-line option) to allow the inner lint check attribute:
1412
1413 ```
1414 #![deny(non_snake_case)]
1415
1416 #[allow(non_snake_case)]
1417 fn main() {
1418     let MyNumber = 2; // ok!
1419 }
1420 ```
1421
1422 Otherwise, edit the code to pass the lint check, and remove the overruled
1423 attribute:
1424
1425 ```
1426 #![forbid(non_snake_case)]
1427
1428 fn main() {
1429     let my_number = 2;
1430 }
1431 ```
1432 "##,
1433
1434 E0478: r##"
1435 A lifetime bound was not satisfied.
1436
1437 Erroneous code example:
1438
1439 ```compile_fail,E0478
1440 // Check that the explicit lifetime bound (`'SnowWhite`, in this example) must
1441 // outlive all the superbounds from the trait (`'kiss`, in this example).
1442
1443 trait Wedding<'t>: 't { }
1444
1445 struct Prince<'kiss, 'SnowWhite> {
1446     child: Box<Wedding<'kiss> + 'SnowWhite>,
1447     // error: lifetime bound not satisfied
1448 }
1449 ```
1450
1451 In this example, the `'SnowWhite` lifetime is supposed to outlive the `'kiss`
1452 lifetime but the declaration of the `Prince` struct doesn't enforce it. To fix
1453 this issue, you need to specify it:
1454
1455 ```
1456 trait Wedding<'t>: 't { }
1457
1458 struct Prince<'kiss, 'SnowWhite: 'kiss> { // You say here that 'kiss must live
1459                                           // longer than 'SnowWhite.
1460     child: Box<Wedding<'kiss> + 'SnowWhite>, // And now it's all good!
1461 }
1462 ```
1463 "##,
1464
1465 E0491: r##"
1466 A reference has a longer lifetime than the data it references.
1467
1468 Erroneous code example:
1469
1470 ```compile_fail,E0491
1471 trait SomeTrait<'a> {
1472     type Output;
1473 }
1474
1475 impl<'a, T> SomeTrait<'a> for T {
1476     type Output = &'a T; // compile error E0491
1477 }
1478 ```
1479
1480 Here, the problem is that a reference type like `&'a T` is only valid
1481 if all the data in T outlives the lifetime `'a`. But this impl as written
1482 is applicable to any lifetime `'a` and any type `T` -- we have no guarantee
1483 that `T` outlives `'a`. To fix this, you can add a where clause like
1484 `where T: 'a`.
1485
1486 ```
1487 trait SomeTrait<'a> {
1488     type Output;
1489 }
1490
1491 impl<'a, T> SomeTrait<'a> for T
1492 where
1493     T: 'a,
1494 {
1495     type Output = &'a T; // compile error E0491
1496 }
1497 ```
1498 "##,
1499
1500 E0496: r##"
1501 A lifetime name is shadowing another lifetime name. Erroneous code example:
1502
1503 ```compile_fail,E0496
1504 struct Foo<'a> {
1505     a: &'a i32,
1506 }
1507
1508 impl<'a> Foo<'a> {
1509     fn f<'a>(x: &'a i32) { // error: lifetime name `'a` shadows a lifetime
1510                            //        name that is already in scope
1511     }
1512 }
1513 ```
1514
1515 Please change the name of one of the lifetimes to remove this error. Example:
1516
1517 ```
1518 struct Foo<'a> {
1519     a: &'a i32,
1520 }
1521
1522 impl<'a> Foo<'a> {
1523     fn f<'b>(x: &'b i32) { // ok!
1524     }
1525 }
1526
1527 fn main() {
1528 }
1529 ```
1530 "##,
1531
1532 E0497: r##"
1533 A stability attribute was used outside of the standard library. Erroneous code
1534 example:
1535
1536 ```compile_fail
1537 #[stable] // error: stability attributes may not be used outside of the
1538           //        standard library
1539 fn foo() {}
1540 ```
1541
1542 It is not possible to use stability attributes outside of the standard library.
1543 Also, for now, it is not possible to write deprecation messages either.
1544 "##,
1545
1546 E0512: r##"
1547 Transmute with two differently sized types was attempted. Erroneous code
1548 example:
1549
1550 ```compile_fail,E0512
1551 fn takes_u8(_: u8) {}
1552
1553 fn main() {
1554     unsafe { takes_u8(::std::mem::transmute(0u16)); }
1555     // error: cannot transmute between types of different sizes,
1556     //        or dependently-sized types
1557 }
1558 ```
1559
1560 Please use types with same size or use the expected type directly. Example:
1561
1562 ```
1563 fn takes_u8(_: u8) {}
1564
1565 fn main() {
1566     unsafe { takes_u8(::std::mem::transmute(0i8)); } // ok!
1567     // or:
1568     unsafe { takes_u8(0u8); } // ok!
1569 }
1570 ```
1571 "##,
1572
1573 E0517: r##"
1574 This error indicates that a `#[repr(..)]` attribute was placed on an
1575 unsupported item.
1576
1577 Examples of erroneous code:
1578
1579 ```compile_fail,E0517
1580 #[repr(C)]
1581 type Foo = u8;
1582
1583 #[repr(packed)]
1584 enum Foo {Bar, Baz}
1585
1586 #[repr(u8)]
1587 struct Foo {bar: bool, baz: bool}
1588
1589 #[repr(C)]
1590 impl Foo {
1591     // ...
1592 }
1593 ```
1594
1595 * The `#[repr(C)]` attribute can only be placed on structs and enums.
1596 * The `#[repr(packed)]` and `#[repr(simd)]` attributes only work on structs.
1597 * The `#[repr(u8)]`, `#[repr(i16)]`, etc attributes only work on enums.
1598
1599 These attributes do not work on typedefs, since typedefs are just aliases.
1600
1601 Representations like `#[repr(u8)]`, `#[repr(i64)]` are for selecting the
1602 discriminant size for enums with no data fields on any of the variants, e.g.
1603 `enum Color {Red, Blue, Green}`, effectively setting the size of the enum to
1604 the size of the provided type. Such an enum can be cast to a value of the same
1605 type as well. In short, `#[repr(u8)]` makes the enum behave like an integer
1606 with a constrained set of allowed values.
1607
1608 Only field-less enums can be cast to numerical primitives, so this attribute
1609 will not apply to structs.
1610
1611 `#[repr(packed)]` reduces padding to make the struct size smaller. The
1612 representation of enums isn't strictly defined in Rust, and this attribute
1613 won't work on enums.
1614
1615 `#[repr(simd)]` will give a struct consisting of a homogeneous series of machine
1616 types (i.e., `u8`, `i32`, etc) a representation that permits vectorization via
1617 SIMD. This doesn't make much sense for enums since they don't consist of a
1618 single list of data.
1619 "##,
1620
1621 E0518: r##"
1622 This error indicates that an `#[inline(..)]` attribute was incorrectly placed
1623 on something other than a function or method.
1624
1625 Examples of erroneous code:
1626
1627 ```compile_fail,E0518
1628 #[inline(always)]
1629 struct Foo;
1630
1631 #[inline(never)]
1632 impl Foo {
1633     // ...
1634 }
1635 ```
1636
1637 `#[inline]` hints the compiler whether or not to attempt to inline a method or
1638 function. By default, the compiler does a pretty good job of figuring this out
1639 itself, but if you feel the need for annotations, `#[inline(always)]` and
1640 `#[inline(never)]` can override or force the compiler's decision.
1641
1642 If you wish to apply this attribute to all methods in an impl, manually annotate
1643 each method; it is not possible to annotate the entire impl with an `#[inline]`
1644 attribute.
1645 "##,
1646
1647 E0522: r##"
1648 The lang attribute is intended for marking special items that are built-in to
1649 Rust itself. This includes special traits (like `Copy` and `Sized`) that affect
1650 how the compiler behaves, as well as special functions that may be automatically
1651 invoked (such as the handler for out-of-bounds accesses when indexing a slice).
1652 Erroneous code example:
1653
1654 ```compile_fail,E0522
1655 #![feature(lang_items)]
1656
1657 #[lang = "cookie"]
1658 fn cookie() -> ! { // error: definition of an unknown language item: `cookie`
1659     loop {}
1660 }
1661 ```
1662 "##,
1663
1664 E0525: r##"
1665 A closure was used but didn't implement the expected trait.
1666
1667 Erroneous code example:
1668
1669 ```compile_fail,E0525
1670 struct X;
1671
1672 fn foo<T>(_: T) {}
1673 fn bar<T: Fn(u32)>(_: T) {}
1674
1675 fn main() {
1676     let x = X;
1677     let closure = |_| foo(x); // error: expected a closure that implements
1678                               //        the `Fn` trait, but this closure only
1679                               //        implements `FnOnce`
1680     bar(closure);
1681 }
1682 ```
1683
1684 In the example above, `closure` is an `FnOnce` closure whereas the `bar`
1685 function expected an `Fn` closure. In this case, it's simple to fix the issue,
1686 you just have to implement `Copy` and `Clone` traits on `struct X` and it'll
1687 be ok:
1688
1689 ```
1690 #[derive(Clone, Copy)] // We implement `Clone` and `Copy` traits.
1691 struct X;
1692
1693 fn foo<T>(_: T) {}
1694 fn bar<T: Fn(u32)>(_: T) {}
1695
1696 fn main() {
1697     let x = X;
1698     let closure = |_| foo(x);
1699     bar(closure); // ok!
1700 }
1701 ```
1702
1703 To understand better how closures work in Rust, read:
1704 https://doc.rust-lang.org/book/first-edition/closures.html
1705 "##,
1706
1707 E0580: r##"
1708 The `main` function was incorrectly declared.
1709
1710 Erroneous code example:
1711
1712 ```compile_fail,E0580
1713 fn main(x: i32) { // error: main function has wrong type
1714     println!("{}", x);
1715 }
1716 ```
1717
1718 The `main` function prototype should never take arguments.
1719 Example:
1720
1721 ```
1722 fn main() {
1723     // your code
1724 }
1725 ```
1726
1727 If you want to get command-line arguments, use `std::env::args`. To exit with a
1728 specified exit code, use `std::process::exit`.
1729 "##,
1730
1731 E0562: r##"
1732 Abstract return types (written `impl Trait` for some trait `Trait`) are only
1733 allowed as function and inherent impl return types.
1734
1735 Erroneous code example:
1736
1737 ```compile_fail,E0562
1738 fn main() {
1739     let count_to_ten: impl Iterator<Item=usize> = 0..10;
1740     // error: `impl Trait` not allowed outside of function and inherent method
1741     //        return types
1742     for i in count_to_ten {
1743         println!("{}", i);
1744     }
1745 }
1746 ```
1747
1748 Make sure `impl Trait` only appears in return-type position.
1749
1750 ```
1751 fn count_to_n(n: usize) -> impl Iterator<Item=usize> {
1752     0..n
1753 }
1754
1755 fn main() {
1756     for i in count_to_n(10) {  // ok!
1757         println!("{}", i);
1758     }
1759 }
1760 ```
1761
1762 See [RFC 1522] for more details.
1763
1764 [RFC 1522]: https://github.com/rust-lang/rfcs/blob/master/text/1522-conservative-impl-trait.md
1765 "##,
1766
1767 E0591: r##"
1768 Per [RFC 401][rfc401], if you have a function declaration `foo`:
1769
1770 ```
1771 // For the purposes of this explanation, all of these
1772 // different kinds of `fn` declarations are equivalent:
1773 struct S;
1774 fn foo(x: S) { /* ... */ }
1775 # #[cfg(for_demonstration_only)]
1776 extern "C" { fn foo(x: S); }
1777 # #[cfg(for_demonstration_only)]
1778 impl S { fn foo(self) { /* ... */ } }
1779 ```
1780
1781 the type of `foo` is **not** `fn(S)`, as one might expect.
1782 Rather, it is a unique, zero-sized marker type written here as `typeof(foo)`.
1783 However, `typeof(foo)` can be _coerced_ to a function pointer `fn(S)`,
1784 so you rarely notice this:
1785
1786 ```
1787 # struct S;
1788 # fn foo(_: S) {}
1789 let x: fn(S) = foo; // OK, coerces
1790 ```
1791
1792 The reason that this matter is that the type `fn(S)` is not specific to
1793 any particular function: it's a function _pointer_. So calling `x()` results
1794 in a virtual call, whereas `foo()` is statically dispatched, because the type
1795 of `foo` tells us precisely what function is being called.
1796
1797 As noted above, coercions mean that most code doesn't have to be
1798 concerned with this distinction. However, you can tell the difference
1799 when using **transmute** to convert a fn item into a fn pointer.
1800
1801 This is sometimes done as part of an FFI:
1802
1803 ```compile_fail,E0591
1804 extern "C" fn foo(userdata: Box<i32>) {
1805     /* ... */
1806 }
1807
1808 # fn callback(_: extern "C" fn(*mut i32)) {}
1809 # use std::mem::transmute;
1810 # unsafe {
1811 let f: extern "C" fn(*mut i32) = transmute(foo);
1812 callback(f);
1813 # }
1814 ```
1815
1816 Here, transmute is being used to convert the types of the fn arguments.
1817 This pattern is incorrect because, because the type of `foo` is a function
1818 **item** (`typeof(foo)`), which is zero-sized, and the target type (`fn()`)
1819 is a function pointer, which is not zero-sized.
1820 This pattern should be rewritten. There are a few possible ways to do this:
1821
1822 - change the original fn declaration to match the expected signature,
1823   and do the cast in the fn body (the preferred option)
1824 - cast the fn item fo a fn pointer before calling transmute, as shown here:
1825
1826     ```
1827     # extern "C" fn foo(_: Box<i32>) {}
1828     # use std::mem::transmute;
1829     # unsafe {
1830     let f: extern "C" fn(*mut i32) = transmute(foo as extern "C" fn(_));
1831     let f: extern "C" fn(*mut i32) = transmute(foo as usize); // works too
1832     # }
1833     ```
1834
1835 The same applies to transmutes to `*mut fn()`, which were observedin practice.
1836 Note though that use of this type is generally incorrect.
1837 The intention is typically to describe a function pointer, but just `fn()`
1838 alone suffices for that. `*mut fn()` is a pointer to a fn pointer.
1839 (Since these values are typically just passed to C code, however, this rarely
1840 makes a difference in practice.)
1841
1842 [rfc401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
1843 "##,
1844
1845 E0593: r##"
1846 You tried to supply an `Fn`-based type with an incorrect number of arguments
1847 than what was expected.
1848
1849 Erroneous code example:
1850
1851 ```compile_fail,E0593
1852 fn foo<F: Fn()>(x: F) { }
1853
1854 fn main() {
1855     // [E0593] closure takes 1 argument but 0 arguments are required
1856     foo(|y| { });
1857 }
1858 ```
1859 "##,
1860
1861 E0601: r##"
1862 No `main` function was found in a binary crate. To fix this error, add a
1863 `main` function. For example:
1864
1865 ```
1866 fn main() {
1867     // Your program will start here.
1868     println!("Hello world!");
1869 }
1870 ```
1871
1872 If you don't know the basics of Rust, you can go look to the Rust Book to get
1873 started: https://doc.rust-lang.org/book/
1874 "##,
1875
1876 E0602: r##"
1877 An unknown lint was used on the command line.
1878
1879 Erroneous example:
1880
1881 ```sh
1882 rustc -D bogus omse_file.rs
1883 ```
1884
1885 Maybe you just misspelled the lint name or the lint doesn't exist anymore.
1886 Either way, try to update/remove it in order to fix the error.
1887 "##,
1888
1889 E0621: r##"
1890 This error code indicates a mismatch between the lifetimes appearing in the
1891 function signature (i.e., the parameter types and the return type) and the
1892 data-flow found in the function body.
1893
1894 Erroneous code example:
1895
1896 ```compile_fail,E0621
1897 fn foo<'a>(x: &'a i32, y: &i32) -> &'a i32 { // error: explicit lifetime
1898                                              //        required in the type of
1899                                              //        `y`
1900     if x > y { x } else { y }
1901 }
1902 ```
1903
1904 In the code above, the function is returning data borrowed from either `x` or
1905 `y`, but the `'a` annotation indicates that it is returning data only from `x`.
1906 To fix the error, the signature and the body must be made to match. Typically,
1907 this is done by updating the function signature. So, in this case, we change
1908 the type of `y` to `&'a i32`, like so:
1909
1910 ```
1911 fn foo<'a>(x: &'a i32, y: &'a i32) -> &'a i32 {
1912     if x > y { x } else { y }
1913 }
1914 ```
1915
1916 Now the signature indicates that the function data borrowed from either `x` or
1917 `y`. Alternatively, you could change the body to not return data from `y`:
1918
1919 ```
1920 fn foo<'a>(x: &'a i32, y: &i32) -> &'a i32 {
1921     x
1922 }
1923 ```
1924 "##,
1925
1926 E0635: r##"
1927 The `#![feature]` attribute specified an unknown feature.
1928
1929 Erroneous code example:
1930
1931 ```compile_fail,E0635
1932 #![feature(nonexistent_rust_feature)] // error: unknown feature
1933 ```
1934
1935 "##,
1936
1937 E0636: r##"
1938 A `#![feature]` attribute was declared multiple times.
1939
1940 Erroneous code example:
1941
1942 ```compile_fail,E0636
1943 #![allow(stable_features)]
1944 #![feature(rust1)]
1945 #![feature(rust1)] // error: the feature `rust1` has already been declared
1946 ```
1947
1948 "##,
1949
1950 E0644: r##"
1951 A closure or generator was constructed that references its own type.
1952
1953 Erroneous example:
1954
1955 ```compile-fail,E0644
1956 fn fix<F>(f: &F)
1957   where F: Fn(&F)
1958 {
1959   f(&f);
1960 }
1961
1962 fn main() {
1963   fix(&|y| {
1964     // Here, when `x` is called, the parameter `y` is equal to `x`.
1965   });
1966 }
1967 ```
1968
1969 Rust does not permit a closure to directly reference its own type,
1970 either through an argument (as in the example above) or by capturing
1971 itself through its environment. This restriction helps keep closure
1972 inference tractable.
1973
1974 The easiest fix is to rewrite your closure into a top-level function,
1975 or into a method. In some cases, you may also be able to have your
1976 closure call itself by capturing a `&Fn()` object or `fn()` pointer
1977 that refers to itself. That is permitting, since the closure would be
1978 invoking itself via a virtual call, and hence does not directly
1979 reference its own *type*.
1980
1981 "##,
1982
1983 E0692: r##"
1984 A `repr(transparent)` type was also annotated with other, incompatible
1985 representation hints.
1986
1987 Erroneous code example:
1988
1989 ```compile_fail,E0692
1990 #[repr(transparent, C)] // error: incompatible representation hints
1991 struct Grams(f32);
1992 ```
1993
1994 A type annotated as `repr(transparent)` delegates all representation concerns to
1995 another type, so adding more representation hints is contradictory. Remove
1996 either the `transparent` hint or the other hints, like this:
1997
1998 ```
1999 #[repr(transparent)]
2000 struct Grams(f32);
2001 ```
2002
2003 Alternatively, move the other attributes to the contained type:
2004
2005 ```
2006 #[repr(C)]
2007 struct Foo {
2008     x: i32,
2009     // ...
2010 }
2011
2012 #[repr(transparent)]
2013 struct FooWrapper(Foo);
2014 ```
2015
2016 Note that introducing another `struct` just to have a place for the other
2017 attributes may have unintended side effects on the representation:
2018
2019 ```
2020 #[repr(transparent)]
2021 struct Grams(f32);
2022
2023 #[repr(C)]
2024 struct Float(f32);
2025
2026 #[repr(transparent)]
2027 struct Grams2(Float); // this is not equivalent to `Grams` above
2028 ```
2029
2030 Here, `Grams2` is a not equivalent to `Grams` -- the former transparently wraps
2031 a (non-transparent) struct containing a single float, while `Grams` is a
2032 transparent wrapper around a float. This can make a difference for the ABI.
2033 "##,
2034
2035 E0700: r##"
2036 The `impl Trait` return type captures lifetime parameters that do not
2037 appear within the `impl Trait` itself.
2038
2039 Erroneous code example:
2040
2041 ```compile-fail,E0700
2042 use std::cell::Cell;
2043
2044 trait Trait<'a> { }
2045
2046 impl<'a, 'b> Trait<'b> for Cell<&'a u32> { }
2047
2048 fn foo<'x, 'y>(x: Cell<&'x u32>) -> impl Trait<'y>
2049 where 'x: 'y
2050 {
2051     x
2052 }
2053 ```
2054
2055 Here, the function `foo` returns a value of type `Cell<&'x u32>`,
2056 which references the lifetime `'x`. However, the return type is
2057 declared as `impl Trait<'y>` -- this indicates that `foo` returns
2058 "some type that implements `Trait<'y>`", but it also indicates that
2059 the return type **only captures data referencing the lifetime `'y`**.
2060 In this case, though, we are referencing data with lifetime `'x`, so
2061 this function is in error.
2062
2063 To fix this, you must reference the lifetime `'x` from the return
2064 type. For example, changing the return type to `impl Trait<'y> + 'x`
2065 would work:
2066
2067 ```
2068 use std::cell::Cell;
2069
2070 trait Trait<'a> { }
2071
2072 impl<'a,'b> Trait<'b> for Cell<&'a u32> { }
2073
2074 fn foo<'x, 'y>(x: Cell<&'x u32>) -> impl Trait<'y> + 'x
2075 where 'x: 'y
2076 {
2077     x
2078 }
2079 ```
2080 "##,
2081
2082 E0701: r##"
2083 This error indicates that a `#[non_exhaustive]` attribute was incorrectly placed
2084 on something other than a struct or enum.
2085
2086 Examples of erroneous code:
2087
2088 ```compile_fail,E0701
2089 # #![feature(non_exhaustive)]
2090
2091 #[non_exhaustive]
2092 trait Foo { }
2093 ```
2094 "##,
2095
2096 E0702: r##"
2097 This error indicates that a `#[non_exhaustive]` attribute had a value. The
2098 `#[non_exhaustive]` should be empty.
2099
2100 Examples of erroneous code:
2101
2102 ```compile_fail,E0702
2103 # #![feature(non_exhaustive)]
2104
2105 #[non_exhaustive(anything)]
2106 struct Foo;
2107 ```
2108 "##,
2109
2110 E0718: r##"
2111 This error indicates that a `#[lang = ".."]` attribute was placed
2112 on the wrong type of item.
2113
2114 Examples of erroneous code:
2115
2116 ```compile_fail,E0718
2117 #![feature(lang_items)]
2118
2119 #[lang = "arc"]
2120 static X: u32 = 42;
2121 ```
2122 "##,
2123
2124 }
2125
2126
2127 register_diagnostics! {
2128 //  E0006, // merged with E0005
2129 //  E0101, // replaced with E0282
2130 //  E0102, // replaced with E0282
2131 //  E0134,
2132 //  E0135,
2133 //  E0272, // on_unimplemented #0
2134 //  E0273, // on_unimplemented #1
2135 //  E0274, // on_unimplemented #2
2136     E0278, // requirement is not satisfied
2137     E0279, // requirement is not satisfied
2138     E0280, // requirement is not satisfied
2139     E0284, // cannot resolve type
2140 //  E0285, // overflow evaluation builtin bounds
2141 //  E0300, // unexpanded macro
2142 //  E0304, // expected signed integer constant
2143 //  E0305, // expected constant
2144     E0311, // thing may not live long enough
2145     E0312, // lifetime of reference outlives lifetime of borrowed content
2146     E0313, // lifetime of borrowed pointer outlives lifetime of captured variable
2147     E0314, // closure outlives stack frame
2148     E0315, // cannot invoke closure outside of its lifetime
2149     E0316, // nested quantification of lifetimes
2150     E0320, // recursive overflow during dropck
2151     E0473, // dereference of reference outside its lifetime
2152     E0474, // captured variable `..` does not outlive the enclosing closure
2153     E0475, // index of slice outside its lifetime
2154     E0476, // lifetime of the source pointer does not outlive lifetime bound...
2155     E0477, // the type `..` does not fulfill the required lifetime...
2156     E0479, // the type `..` (provided as the value of a type parameter) is...
2157     E0480, // lifetime of method receiver does not outlive the method call
2158     E0481, // lifetime of function argument does not outlive the function call
2159     E0482, // lifetime of return value does not outlive the function call
2160     E0483, // lifetime of operand does not outlive the operation
2161     E0484, // reference is not valid at the time of borrow
2162     E0485, // automatically reference is not valid at the time of borrow
2163     E0486, // type of expression contains references that are not valid during...
2164     E0487, // unsafe use of destructor: destructor might be called while...
2165     E0488, // lifetime of variable does not enclose its declaration
2166     E0489, // type/lifetime parameter not in scope here
2167     E0490, // a value of type `..` is borrowed for too long
2168     E0495, // cannot infer an appropriate lifetime due to conflicting requirements
2169     E0566, // conflicting representation hints
2170     E0623, // lifetime mismatch where both parameters are anonymous regions
2171     E0628, // generators cannot have explicit arguments
2172     E0631, // type mismatch in closure arguments
2173     E0637, // "'_" is not a valid lifetime bound
2174     E0657, // `impl Trait` can only capture lifetimes bound at the fn level
2175     E0687, // in-band lifetimes cannot be used in `fn`/`Fn` syntax
2176     E0688, // in-band lifetimes cannot be mixed with explicit lifetime binders
2177     E0697, // closures cannot be static
2178     E0707, // multiple elided lifetimes used in arguments of `async fn`
2179     E0708, // `async` non-`move` closures with arguments are not currently supported
2180     E0709, // multiple different lifetimes used in arguments of `async fn`
2181     E0710, // an unknown tool name found in scoped lint
2182     E0711, // a feature has been declared with conflicting stability attributes
2183 }