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