library/core/src/macros/mod.rs

   1 #[doc = include_str!("panic.md")]
   2 #[macro_export]
   3 #[rustc_builtin_macro(core_panic)]
   4 #[allow_internal_unstable(edition_panic)]
   5 #[stable(feature = "core", since = "1.6.0")]
   6 #[rustc_diagnostic_item = "core_panic_macro"]
   7 macro_rules! panic {
   8     // Expands to either `$crate::panic::panic_2015` or `$crate::panic::panic_2021`
   9     // depending on the edition of the caller.
  10     ($($arg:tt)*) => {
  11         /* compiler built-in */
  12     };
  13 }
  14
  15 /// Asserts that two expressions are equal to each other (using [`PartialEq`]).
  16 ///
  17 /// On panic, this macro will print the values of the expressions with their
  18 /// debug representations.
  19 ///
  20 /// Like [`assert!`], this macro has a second form, where a custom
  21 /// panic message can be provided.
  22 ///
  23 /// # Examples
  24 ///
  25 /// ```
  26 /// let a = 3;
  27 /// let b = 1 + 2;
  28 /// assert_eq!(a, b);
  29 ///
  30 /// assert_eq!(a, b, "we are testing addition with {} and {}", a, b);
  31 /// ```
  32 #[macro_export]
  33 #[stable(feature = "rust1", since = "1.0.0")]
  34 #[cfg_attr(not(test), rustc_diagnostic_item = "assert_eq_macro")]
  35 #[allow_internal_unstable(core_panic)]
  36 macro_rules! assert_eq {
  37     ($left:expr, $right:expr $(,)?) => {
  38         match (&$left, &$right) {
  39             (left_val, right_val) => {
  40                 if !(*left_val == *right_val) {
  41                     let kind = $crate::panicking::AssertKind::Eq;
  42                     // The reborrows below are intentional. Without them, the stack slot for the
  43                     // borrow is initialized even before the values are compared, leading to a
  44                     // noticeable slow down.
  45                     $crate::panicking::assert_failed(kind, &*left_val, &*right_val, $crate::option::Option::None);
  46                 }
  47             }
  48         }
  49     };
  50     ($left:expr, $right:expr, $($arg:tt)+) => {
  51         match (&$left, &$right) {
  52             (left_val, right_val) => {
  53                 if !(*left_val == *right_val) {
  54                     let kind = $crate::panicking::AssertKind::Eq;
  55                     // The reborrows below are intentional. Without them, the stack slot for the
  56                     // borrow is initialized even before the values are compared, leading to a
  57                     // noticeable slow down.
  58                     $crate::panicking::assert_failed(kind, &*left_val, &*right_val, $crate::option::Option::Some($crate::format_args!($($arg)+)));
  59                 }
  60             }
  61         }
  62     };
  63 }
  64
  65 /// Asserts that two expressions are not equal to each other (using [`PartialEq`]).
  66 ///
  67 /// On panic, this macro will print the values of the expressions with their
  68 /// debug representations.
  69 ///
  70 /// Like [`assert!`], this macro has a second form, where a custom
  71 /// panic message can be provided.
  72 ///
  73 /// # Examples
  74 ///
  75 /// ```
  76 /// let a = 3;
  77 /// let b = 2;
  78 /// assert_ne!(a, b);
  79 ///
  80 /// assert_ne!(a, b, "we are testing that the values are not equal");
  81 /// ```
  82 #[macro_export]
  83 #[stable(feature = "assert_ne", since = "1.13.0")]
  84 #[cfg_attr(not(test), rustc_diagnostic_item = "assert_ne_macro")]
  85 #[allow_internal_unstable(core_panic)]
  86 macro_rules! assert_ne {
  87     ($left:expr, $right:expr $(,)?) => {
  88         match (&$left, &$right) {
  89             (left_val, right_val) => {
  90                 if *left_val == *right_val {
  91                     let kind = $crate::panicking::AssertKind::Ne;
  92                     // The reborrows below are intentional. Without them, the stack slot for the
  93                     // borrow is initialized even before the values are compared, leading to a
  94                     // noticeable slow down.
  95                     $crate::panicking::assert_failed(kind, &*left_val, &*right_val, $crate::option::Option::None);
  96                 }
  97             }
  98         }
  99     };
 100     ($left:expr, $right:expr, $($arg:tt)+) => {
 101         match (&($left), &($right)) {
 102             (left_val, right_val) => {
 103                 if *left_val == *right_val {
 104                     let kind = $crate::panicking::AssertKind::Ne;
 105                     // The reborrows below are intentional. Without them, the stack slot for the
 106                     // borrow is initialized even before the values are compared, leading to a
 107                     // noticeable slow down.
 108                     $crate::panicking::assert_failed(kind, &*left_val, &*right_val, $crate::option::Option::Some($crate::format_args!($($arg)+)));
 109                 }
 110             }
 111         }
 112     };
 113 }
 114
 115 /// Asserts that an expression matches any of the given patterns.
 116 ///
 117 /// Like in a `match` expression, the pattern can be optionally followed by `if`
 118 /// and a guard expression that has access to names bound by the pattern.
 119 ///
 120 /// On panic, this macro will print the value of the expression with its
 121 /// debug representation.
 122 ///
 123 /// Like [`assert!`], this macro has a second form, where a custom
 124 /// panic message can be provided.
 125 ///
 126 /// # Examples
 127 ///
 128 /// ```
 129 /// #![feature(assert_matches)]
 130 ///
 131 /// use std::assert_matches::assert_matches;
 132 ///
 133 /// let a = 1u32.checked_add(2);
 134 /// let b = 1u32.checked_sub(2);
 135 /// assert_matches!(a, Some(_));
 136 /// assert_matches!(b, None);
 137 ///
 138 /// let c = Ok("abc".to_string());
 139 /// assert_matches!(c, Ok(x) | Err(x) if x.len() < 100);
 140 /// ```
 141 #[unstable(feature = "assert_matches", issue = "82775")]
 142 #[allow_internal_unstable(core_panic)]
 143 #[rustc_macro_transparency = "semitransparent"]
 144 pub macro assert_matches {
 145     ($left:expr, $(|)? $( $pattern:pat_param )|+ $( if $guard: expr )? $(,)?) => {
 146         match $left {
 147             $( $pattern )|+ $( if $guard )? => {}
 148             ref left_val => {
 149                 $crate::panicking::assert_matches_failed(
 150                     left_val,
 151                     $crate::stringify!($($pattern)|+ $(if $guard)?),
 152                     $crate::option::Option::None
 153                 );
 154             }
 155         }
 156     },
 157     ($left:expr, $(|)? $( $pattern:pat_param )|+ $( if $guard: expr )?, $($arg:tt)+) => {
 158         match $left {
 159             $( $pattern )|+ $( if $guard )? => {}
 160             ref left_val => {
 161                 $crate::panicking::assert_matches_failed(
 162                     left_val,
 163                     $crate::stringify!($($pattern)|+ $(if $guard)?),
 164                     $crate::option::Option::Some($crate::format_args!($($arg)+))
 165                 );
 166             }
 167         }
 168     },
 169 }
 170
 171 /// Asserts that a boolean expression is `true` at runtime.
 172 ///
 173 /// This will invoke the [`panic!`] macro if the provided expression cannot be
 174 /// evaluated to `true` at runtime.
 175 ///
 176 /// Like [`assert!`], this macro also has a second version, where a custom panic
 177 /// message can be provided.
 178 ///
 179 /// # Uses
 180 ///
 181 /// Unlike [`assert!`], `debug_assert!` statements are only enabled in non
 182 /// optimized builds by default. An optimized build will not execute
 183 /// `debug_assert!` statements unless `-C debug-assertions` is passed to the
 184 /// compiler. This makes `debug_assert!` useful for checks that are too
 185 /// expensive to be present in a release build but may be helpful during
 186 /// development. The result of expanding `debug_assert!` is always type checked.
 187 ///
 188 /// An unchecked assertion allows a program in an inconsistent state to keep
 189 /// running, which might have unexpected consequences but does not introduce
 190 /// unsafety as long as this only happens in safe code. The performance cost
 191 /// of assertions, however, is not measurable in general. Replacing [`assert!`]
 192 /// with `debug_assert!` is thus only encouraged after thorough profiling, and
 193 /// more importantly, only in safe code!
 194 ///
 195 /// # Examples
 196 ///
 197 /// ```
 198 /// // the panic message for these assertions is the stringified value of the
 199 /// // expression given.
 200 /// debug_assert!(true);
 201 ///
 202 /// fn some_expensive_computation() -> bool { true } // a very simple function
 203 /// debug_assert!(some_expensive_computation());
 204 ///
 205 /// // assert with a custom message
 206 /// let x = true;
 207 /// debug_assert!(x, "x wasn't true!");
 208 ///
 209 /// let a = 3; let b = 27;
 210 /// debug_assert!(a + b == 30, "a = {}, b = {}", a, b);
 211 /// ```
 212 #[macro_export]
 213 #[stable(feature = "rust1", since = "1.0.0")]
 214 #[rustc_diagnostic_item = "debug_assert_macro"]
 215 #[allow_internal_unstable(edition_panic)]
 216 macro_rules! debug_assert {
 217     ($($arg:tt)*) => {
 218         if $crate::cfg!(debug_assertions) {
 219             $crate::assert!($($arg)*);
 220         }
 221     };
 222 }
 223
 224 /// Asserts that two expressions are equal to each other.
 225 ///
 226 /// On panic, this macro will print the values of the expressions with their
 227 /// debug representations.
 228 ///
 229 /// Unlike [`assert_eq!`], `debug_assert_eq!` statements are only enabled in non
 230 /// optimized builds by default. An optimized build will not execute
 231 /// `debug_assert_eq!` statements unless `-C debug-assertions` is passed to the
 232 /// compiler. This makes `debug_assert_eq!` useful for checks that are too
 233 /// expensive to be present in a release build but may be helpful during
 234 /// development. The result of expanding `debug_assert_eq!` is always type checked.
 235 ///
 236 /// # Examples
 237 ///
 238 /// ```
 239 /// let a = 3;
 240 /// let b = 1 + 2;
 241 /// debug_assert_eq!(a, b);
 242 /// ```
 243 #[macro_export]
 244 #[stable(feature = "rust1", since = "1.0.0")]
 245 #[cfg_attr(not(test), rustc_diagnostic_item = "debug_assert_eq_macro")]
 246 macro_rules! debug_assert_eq {
 247     ($($arg:tt)*) => {
 248         if $crate::cfg!(debug_assertions) {
 249             $crate::assert_eq!($($arg)*);
 250         }
 251     };
 252 }
 253
 254 /// Asserts that two expressions are not equal to each other.
 255 ///
 256 /// On panic, this macro will print the values of the expressions with their
 257 /// debug representations.
 258 ///
 259 /// Unlike [`assert_ne!`], `debug_assert_ne!` statements are only enabled in non
 260 /// optimized builds by default. An optimized build will not execute
 261 /// `debug_assert_ne!` statements unless `-C debug-assertions` is passed to the
 262 /// compiler. This makes `debug_assert_ne!` useful for checks that are too
 263 /// expensive to be present in a release build but may be helpful during
 264 /// development. The result of expanding `debug_assert_ne!` is always type checked.
 265 ///
 266 /// # Examples
 267 ///
 268 /// ```
 269 /// let a = 3;
 270 /// let b = 2;
 271 /// debug_assert_ne!(a, b);
 272 /// ```
 273 #[macro_export]
 274 #[stable(feature = "assert_ne", since = "1.13.0")]
 275 #[cfg_attr(not(test), rustc_diagnostic_item = "debug_assert_ne_macro")]
 276 macro_rules! debug_assert_ne {
 277     ($($arg:tt)*) => {
 278         if $crate::cfg!(debug_assertions) {
 279             $crate::assert_ne!($($arg)*);
 280         }
 281     };
 282 }
 283
 284 /// Asserts that an expression matches any of the given patterns.
 285 ///
 286 /// Like in a `match` expression, the pattern can be optionally followed by `if`
 287 /// and a guard expression that has access to names bound by the pattern.
 288 ///
 289 /// On panic, this macro will print the value of the expression with its
 290 /// debug representation.
 291 ///
 292 /// Unlike [`assert_matches!`], `debug_assert_matches!` statements are only
 293 /// enabled in non optimized builds by default. An optimized build will not
 294 /// execute `debug_assert_matches!` statements unless `-C debug-assertions` is
 295 /// passed to the compiler. This makes `debug_assert_matches!` useful for
 296 /// checks that are too expensive to be present in a release build but may be
 297 /// helpful during development. The result of expanding `debug_assert_matches!`
 298 /// is always type checked.
 299 ///
 300 /// # Examples
 301 ///
 302 /// ```
 303 /// #![feature(assert_matches)]
 304 ///
 305 /// use std::assert_matches::debug_assert_matches;
 306 ///
 307 /// let a = 1u32.checked_add(2);
 308 /// let b = 1u32.checked_sub(2);
 309 /// debug_assert_matches!(a, Some(_));
 310 /// debug_assert_matches!(b, None);
 311 ///
 312 /// let c = Ok("abc".to_string());
 313 /// debug_assert_matches!(c, Ok(x) | Err(x) if x.len() < 100);
 314 /// ```
 315 #[macro_export]
 316 #[unstable(feature = "assert_matches", issue = "82775")]
 317 #[allow_internal_unstable(assert_matches)]
 318 #[rustc_macro_transparency = "semitransparent"]
 319 pub macro debug_assert_matches($($arg:tt)*) {
 320     if $crate::cfg!(debug_assertions) {
 321         $crate::assert_matches::assert_matches!($($arg)*);
 322     }
 323 }
 324
 325 /// Returns whether the given expression matches any of the given patterns.
 326 ///
 327 /// Like in a `match` expression, the pattern can be optionally followed by `if`
 328 /// and a guard expression that has access to names bound by the pattern.
 329 ///
 330 /// # Examples
 331 ///
 332 /// ```
 333 /// let foo = 'f';
 334 /// assert!(matches!(foo, 'A'..='Z' | 'a'..='z'));
 335 ///
 336 /// let bar = Some(4);
 337 /// assert!(matches!(bar, Some(x) if x > 2));
 338 /// ```
 339 #[macro_export]
 340 #[stable(feature = "matches_macro", since = "1.42.0")]
 341 macro_rules! matches {
 342     ($expression:expr, $(|)? $( $pattern:pat_param )|+ $( if $guard: expr )? $(,)?) => {
 343         match $expression {
 344             $( $pattern )|+ $( if $guard )? => true,
 345             _ => false
 346         }
 347     };
 348 }
 349
 350 /// Unwraps a result or propagates its error.
 351 ///
 352 /// The [`?` operator][propagating-errors] was added to replace `try!`
 353 /// and should be used instead. Furthermore, `try` is a reserved word
 354 /// in Rust 2018, so if you must use it, you will need to use the
 355 /// [raw-identifier syntax][ris]: `r#try`.
 356 ///
 357 /// [propagating-errors]: https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html#a-shortcut-for-propagating-errors-the--operator
 358 /// [ris]: https://doc.rust-lang.org/nightly/rust-by-example/compatibility/raw_identifiers.html
 359 ///
 360 /// `try!` matches the given [`Result`]. In case of the `Ok` variant, the
 361 /// expression has the value of the wrapped value.
 362 ///
 363 /// In case of the `Err` variant, it retrieves the inner error. `try!` then
 364 /// performs conversion using `From`. This provides automatic conversion
 365 /// between specialized errors and more general ones. The resulting
 366 /// error is then immediately returned.
 367 ///
 368 /// Because of the early return, `try!` can only be used in functions that
 369 /// return [`Result`].
 370 ///
 371 /// # Examples
 372 ///
 373 /// ```
 374 /// use std::io;
 375 /// use std::fs::File;
 376 /// use std::io::prelude::*;
 377 ///
 378 /// enum MyError {
 379 ///     FileWriteError
 380 /// }
 381 ///
 382 /// impl From<io::Error> for MyError {
 383 ///     fn from(e: io::Error) -> MyError {
 384 ///         MyError::FileWriteError
 385 ///     }
 386 /// }
 387 ///
 388 /// // The preferred method of quick returning Errors
 389 /// fn write_to_file_question() -> Result<(), MyError> {
 390 ///     let mut file = File::create("my_best_friends.txt")?;
 391 ///     file.write_all(b"This is a list of my best friends.")?;
 392 ///     Ok(())
 393 /// }
 394 ///
 395 /// // The previous method of quick returning Errors
 396 /// fn write_to_file_using_try() -> Result<(), MyError> {
 397 ///     let mut file = r#try!(File::create("my_best_friends.txt"));
 398 ///     r#try!(file.write_all(b"This is a list of my best friends."));
 399 ///     Ok(())
 400 /// }
 401 ///
 402 /// // This is equivalent to:
 403 /// fn write_to_file_using_match() -> Result<(), MyError> {
 404 ///     let mut file = r#try!(File::create("my_best_friends.txt"));
 405 ///     match file.write_all(b"This is a list of my best friends.") {
 406 ///         Ok(v) => v,
 407 ///         Err(e) => return Err(From::from(e)),
 408 ///     }
 409 ///     Ok(())
 410 /// }
 411 /// ```
 412 #[macro_export]
 413 #[stable(feature = "rust1", since = "1.0.0")]
 414 #[deprecated(since = "1.39.0", note = "use the `?` operator instead")]
 415 #[doc(alias = "?")]
 416 macro_rules! r#try {
 417     ($expr:expr $(,)?) => {
 418         match $expr {
 419             $crate::result::Result::Ok(val) => val,
 420             $crate::result::Result::Err(err) => {
 421                 return $crate::result::Result::Err($crate::convert::From::from(err));
 422             }
 423         }
 424     };
 425 }
 426
 427 /// Writes formatted data into a buffer.
 428 ///
 429 /// This macro accepts a 'writer', a format string, and a list of arguments. Arguments will be
 430 /// formatted according to the specified format string and the result will be passed to the writer.
 431 /// The writer may be any value with a `write_fmt` method; generally this comes from an
 432 /// implementation of either the [`fmt::Write`] or the [`io::Write`] trait. The macro
 433 /// returns whatever the `write_fmt` method returns; commonly a [`fmt::Result`], or an
 434 /// [`io::Result`].
 435 ///
 436 /// See [`std::fmt`] for more information on the format string syntax.
 437 ///
 438 /// [`std::fmt`]: ../std/fmt/index.html
 439 /// [`fmt::Write`]: crate::fmt::Write
 440 /// [`io::Write`]: ../std/io/trait.Write.html
 441 /// [`fmt::Result`]: crate::fmt::Result
 442 /// [`io::Result`]: ../std/io/type.Result.html
 443 ///
 444 /// # Examples
 445 ///
 446 /// ```
 447 /// use std::io::Write;
 448 ///
 449 /// fn main() -> std::io::Result<()> {
 450 ///     let mut w = Vec::new();
 451 ///     write!(&mut w, "test")?;
 452 ///     write!(&mut w, "formatted {}", "arguments")?;
 453 ///
 454 ///     assert_eq!(w, b"testformatted arguments");
 455 ///     Ok(())
 456 /// }
 457 /// ```
 458 ///
 459 /// A module can import both `std::fmt::Write` and `std::io::Write` and call `write!` on objects
 460 /// implementing either, as objects do not typically implement both. However, the module must
 461 /// avoid conflict between the trait names, such as by importing them as `_` or otherwise renaming
 462 /// them:
 463 ///
 464 /// ```
 465 /// use std::fmt::Write as _;
 466 /// use std::io::Write as _;
 467 ///
 468 /// fn main() -> Result<(), Box<dyn std::error::Error>> {
 469 ///     let mut s = String::new();
 470 ///     let mut v = Vec::new();
 471 ///
 472 ///     write!(&mut s, "{} {}", "abc", 123)?; // uses fmt::Write::write_fmt
 473 ///     write!(&mut v, "s = {:?}", s)?; // uses io::Write::write_fmt
 474 ///     assert_eq!(v, b"s = \"abc 123\"");
 475 ///     Ok(())
 476 /// }
 477 /// ```
 478 ///
 479 /// If you also need the trait names themselves, such as to implement one or both on your types,
 480 /// import the containing module and then name them with a prefix:
 481 ///
 482 /// ```
 483 /// # #![allow(unused_imports)]
 484 /// use std::fmt::{self, Write as _};
 485 /// use std::io::{self, Write as _};
 486 ///
 487 /// struct Example;
 488 ///
 489 /// impl fmt::Write for Example {
 490 ///     fn write_str(&mut self, _s: &str) -> core::fmt::Result {
 491 ///          unimplemented!();
 492 ///     }
 493 /// }
 494 /// ```
 495 ///
 496 /// Note: This macro can be used in `no_std` setups as well.
 497 /// In a `no_std` setup you are responsible for the implementation details of the components.
 498 ///
 499 /// ```no_run
 500 /// # extern crate core;
 501 /// use core::fmt::Write;
 502 ///
 503 /// struct Example;
 504 ///
 505 /// impl Write for Example {
 506 ///     fn write_str(&mut self, _s: &str) -> core::fmt::Result {
 507 ///          unimplemented!();
 508 ///     }
 509 /// }
 510 ///
 511 /// let mut m = Example{};
 512 /// write!(&mut m, "Hello World").expect("Not written");
 513 /// ```
 514 #[macro_export]
 515 #[stable(feature = "rust1", since = "1.0.0")]
 516 #[cfg_attr(not(test), rustc_diagnostic_item = "write_macro")]
 517 macro_rules! write {
 518     ($dst:expr, $($arg:tt)*) => {
 519         $dst.write_fmt($crate::format_args!($($arg)*))
 520     };
 521 }
 522
 523 /// Write formatted data into a buffer, with a newline appended.
 524 ///
 525 /// On all platforms, the newline is the LINE FEED character (`\n`/`U+000A`) alone
 526 /// (no additional CARRIAGE RETURN (`\r`/`U+000D`).
 527 ///
 528 /// For more information, see [`write!`]. For information on the format string syntax, see
 529 /// [`std::fmt`].
 530 ///
 531 /// [`std::fmt`]: ../std/fmt/index.html
 532 ///
 533 /// # Examples
 534 ///
 535 /// ```
 536 /// use std::io::{Write, Result};
 537 ///
 538 /// fn main() -> Result<()> {
 539 ///     let mut w = Vec::new();
 540 ///     writeln!(&mut w)?;
 541 ///     writeln!(&mut w, "test")?;
 542 ///     writeln!(&mut w, "formatted {}", "arguments")?;
 543 ///
 544 ///     assert_eq!(&w[..], "\ntest\nformatted arguments\n".as_bytes());
 545 ///     Ok(())
 546 /// }
 547 /// ```
 548 #[macro_export]
 549 #[stable(feature = "rust1", since = "1.0.0")]
 550 #[cfg_attr(not(test), rustc_diagnostic_item = "writeln_macro")]
 551 #[allow_internal_unstable(format_args_nl)]
 552 macro_rules! writeln {
 553     ($dst:expr $(,)?) => {
 554         $crate::write!($dst, "\n")
 555     };
 556     ($dst:expr, $($arg:tt)*) => {
 557         $dst.write_fmt($crate::format_args_nl!($($arg)*))
 558     };
 559 }
 560
 561 /// Indicates unreachable code.
 562 ///
 563 /// This is useful any time that the compiler can't determine that some code is unreachable. For
 564 /// example:
 565 ///
 566 /// * Match arms with guard conditions.
 567 /// * Loops that dynamically terminate.
 568 /// * Iterators that dynamically terminate.
 569 ///
 570 /// If the determination that the code is unreachable proves incorrect, the
 571 /// program immediately terminates with a [`panic!`].
 572 ///
 573 /// The unsafe counterpart of this macro is the [`unreachable_unchecked`] function, which
 574 /// will cause undefined behavior if the code is reached.
 575 ///
 576 /// [`unreachable_unchecked`]: crate::hint::unreachable_unchecked
 577 ///
 578 /// # Panics
 579 ///
 580 /// This will always [`panic!`] because `unreachable!` is just a shorthand for `panic!` with a
 581 /// fixed, specific message.
 582 ///
 583 /// Like `panic!`, this macro has a second form for displaying custom values.
 584 ///
 585 /// # Examples
 586 ///
 587 /// Match arms:
 588 ///
 589 /// ```
 590 /// # #[allow(dead_code)]
 591 /// fn foo(x: Option<i32>) {
 592 ///     match x {
 593 ///         Some(n) if n >= 0 => println!("Some(Non-negative)"),
 594 ///         Some(n) if n <  0 => println!("Some(Negative)"),
 595 ///         Some(_)           => unreachable!(), // compile error if commented out
 596 ///         None              => println!("None")
 597 ///     }
 598 /// }
 599 /// ```
 600 ///
 601 /// Iterators:
 602 ///
 603 /// ```
 604 /// # #[allow(dead_code)]
 605 /// fn divide_by_three(x: u32) -> u32 { // one of the poorest implementations of x/3
 606 ///     for i in 0.. {
 607 ///         if 3*i < i { panic!("u32 overflow"); }
 608 ///         if x < 3*i { return i-1; }
 609 ///     }
 610 ///     unreachable!("The loop should always return");
 611 /// }
 612 /// ```
 613 #[macro_export]
 614 #[rustc_builtin_macro(unreachable)]
 615 #[allow_internal_unstable(edition_panic)]
 616 #[stable(feature = "rust1", since = "1.0.0")]
 617 #[cfg_attr(not(test), rustc_diagnostic_item = "unreachable_macro")]
 618 macro_rules! unreachable {
 619     // Expands to either `$crate::panic::unreachable_2015` or `$crate::panic::unreachable_2021`
 620     // depending on the edition of the caller.
 621     ($($arg:tt)*) => {
 622         /* compiler built-in */
 623     };
 624 }
 625
 626 /// Indicates unimplemented code by panicking with a message of "not implemented".
 627 ///
 628 /// This allows your code to type-check, which is useful if you are prototyping or
 629 /// implementing a trait that requires multiple methods which you don't plan to use all of.
 630 ///
 631 /// The difference between `unimplemented!` and [`todo!`] is that while `todo!`
 632 /// conveys an intent of implementing the functionality later and the message is "not yet
 633 /// implemented", `unimplemented!` makes no such claims. Its message is "not implemented".
 634 /// Also some IDEs will mark `todo!`s.
 635 ///
 636 /// # Panics
 637 ///
 638 /// This will always [`panic!`] because `unimplemented!` is just a shorthand for `panic!` with a
 639 /// fixed, specific message.
 640 ///
 641 /// Like `panic!`, this macro has a second form for displaying custom values.
 642 ///
 643 /// [`todo!`]: crate::todo
 644 ///
 645 /// # Examples
 646 ///
 647 /// Say we have a trait `Foo`:
 648 ///
 649 /// ```
 650 /// trait Foo {
 651 ///     fn bar(&self) -> u8;
 652 ///     fn baz(&self);
 653 ///     fn qux(&self) -> Result<u64, ()>;
 654 /// }
 655 /// ```
 656 ///
 657 /// We want to implement `Foo` for 'MyStruct', but for some reason it only makes sense
 658 /// to implement the `bar()` function. `baz()` and `qux()` will still need to be defined
 659 /// in our implementation of `Foo`, but we can use `unimplemented!` in their definitions
 660 /// to allow our code to compile.
 661 ///
 662 /// We still want to have our program stop running if the unimplemented methods are
 663 /// reached.
 664 ///
 665 /// ```
 666 /// # trait Foo {
 667 /// #     fn bar(&self) -> u8;
 668 /// #     fn baz(&self);
 669 /// #     fn qux(&self) -> Result<u64, ()>;
 670 /// # }
 671 /// struct MyStruct;
 672 ///
 673 /// impl Foo for MyStruct {
 674 ///     fn bar(&self) -> u8 {
 675 ///         1 + 1
 676 ///     }
 677 ///
 678 ///     fn baz(&self) {
 679 ///         // It makes no sense to `baz` a `MyStruct`, so we have no logic here
 680 ///         // at all.
 681 ///         // This will display "thread 'main' panicked at 'not implemented'".
 682 ///         unimplemented!();
 683 ///     }
 684 ///
 685 ///     fn qux(&self) -> Result<u64, ()> {
 686 ///         // We have some logic here,
 687 ///         // We can add a message to unimplemented! to display our omission.
 688 ///         // This will display:
 689 ///         // "thread 'main' panicked at 'not implemented: MyStruct isn't quxable'".
 690 ///         unimplemented!("MyStruct isn't quxable");
 691 ///     }
 692 /// }
 693 ///
 694 /// fn main() {
 695 ///     let s = MyStruct;
 696 ///     s.bar();
 697 /// }
 698 /// ```
 699 #[macro_export]
 700 #[stable(feature = "rust1", since = "1.0.0")]
 701 #[cfg_attr(not(test), rustc_diagnostic_item = "unimplemented_macro")]
 702 #[allow_internal_unstable(core_panic)]
 703 macro_rules! unimplemented {
 704     () => {
 705         $crate::panicking::panic("not implemented")
 706     };
 707     ($($arg:tt)+) => {
 708         $crate::panic!("not implemented: {}", $crate::format_args!($($arg)+))
 709     };
 710 }
 711
 712 /// Indicates unfinished code.
 713 ///
 714 /// This can be useful if you are prototyping and are just looking to have your
 715 /// code typecheck.
 716 ///
 717 /// The difference between [`unimplemented!`] and `todo!` is that while `todo!` conveys
 718 /// an intent of implementing the functionality later and the message is "not yet
 719 /// implemented", `unimplemented!` makes no such claims. Its message is "not implemented".
 720 /// Also some IDEs will mark `todo!`s.
 721 ///
 722 /// # Panics
 723 ///
 724 /// This will always [`panic!`].
 725 ///
 726 /// # Examples
 727 ///
 728 /// Here's an example of some in-progress code. We have a trait `Foo`:
 729 ///
 730 /// ```
 731 /// trait Foo {
 732 ///     fn bar(&self);
 733 ///     fn baz(&self);
 734 /// }
 735 /// ```
 736 ///
 737 /// We want to implement `Foo` on one of our types, but we also want to work on
 738 /// just `bar()` first. In order for our code to compile, we need to implement
 739 /// `baz()`, so we can use `todo!`:
 740 ///
 741 /// ```
 742 /// # trait Foo {
 743 /// #     fn bar(&self);
 744 /// #     fn baz(&self);
 745 /// # }
 746 /// struct MyStruct;
 747 ///
 748 /// impl Foo for MyStruct {
 749 ///     fn bar(&self) {
 750 ///         // implementation goes here
 751 ///     }
 752 ///
 753 ///     fn baz(&self) {
 754 ///         // let's not worry about implementing baz() for now
 755 ///         todo!();
 756 ///     }
 757 /// }
 758 ///
 759 /// fn main() {
 760 ///     let s = MyStruct;
 761 ///     s.bar();
 762 ///
 763 ///     // we aren't even using baz(), so this is fine.
 764 /// }
 765 /// ```
 766 #[macro_export]
 767 #[stable(feature = "todo_macro", since = "1.40.0")]
 768 #[cfg_attr(not(test), rustc_diagnostic_item = "todo_macro")]
 769 #[allow_internal_unstable(core_panic)]
 770 macro_rules! todo {
 771     () => {
 772         $crate::panicking::panic("not yet implemented")
 773     };
 774     ($($arg:tt)+) => {
 775         $crate::panic!("not yet implemented: {}", $crate::format_args!($($arg)+))
 776     };
 777 }
 778
 779 /// Definitions of built-in macros.
 780 ///
 781 /// Most of the macro properties (stability, visibility, etc.) are taken from the source code here,
 782 /// with exception of expansion functions transforming macro inputs into outputs,
 783 /// those functions are provided by the compiler.
 784 pub(crate) mod builtin {
 785
 786     /// Causes compilation to fail with the given error message when encountered.
 787     ///
 788     /// This macro should be used when a crate uses a conditional compilation strategy to provide
 789     /// better error messages for erroneous conditions. It's the compiler-level form of [`panic!`],
 790     /// but emits an error during *compilation* rather than at *runtime*.
 791     ///
 792     /// # Examples
 793     ///
 794     /// Two such examples are macros and `#[cfg]` environments.
 795     ///
 796     /// Emit a better compiler error if a macro is passed invalid values. Without the final branch,
 797     /// the compiler would still emit an error, but the error's message would not mention the two
 798     /// valid values.
 799     ///
 800     /// ```compile_fail
 801     /// macro_rules! give_me_foo_or_bar {
 802     ///     (foo) => {};
 803     ///     (bar) => {};
 804     ///     ($x:ident) => {
 805     ///         compile_error!("This macro only accepts `foo` or `bar`");
 806     ///     }
 807     /// }
 808     ///
 809     /// give_me_foo_or_bar!(neither);
 810     /// // ^ will fail at compile time with message "This macro only accepts `foo` or `bar`"
 811     /// ```
 812     ///
 813     /// Emit a compiler error if one of a number of features isn't available.
 814     ///
 815     /// ```compile_fail
 816     /// #[cfg(not(any(feature = "foo", feature = "bar")))]
 817     /// compile_error!("Either feature \"foo\" or \"bar\" must be enabled for this crate.");
 818     /// ```
 819     #[stable(feature = "compile_error_macro", since = "1.20.0")]
 820     #[rustc_builtin_macro]
 821     #[macro_export]
 822     macro_rules! compile_error {
 823         ($msg:expr $(,)?) => {{ /* compiler built-in */ }};
 824     }
 825
 826     /// Constructs parameters for the other string-formatting macros.
 827     ///
 828     /// This macro functions by taking a formatting string literal containing
 829     /// `{}` for each additional argument passed. `format_args!` prepares the
 830     /// additional parameters to ensure the output can be interpreted as a string
 831     /// and canonicalizes the arguments into a single type. Any value that implements
 832     /// the [`Display`] trait can be passed to `format_args!`, as can any
 833     /// [`Debug`] implementation be passed to a `{:?}` within the formatting string.
 834     ///
 835     /// This macro produces a value of type [`fmt::Arguments`]. This value can be
 836     /// passed to the macros within [`std::fmt`] for performing useful redirection.
 837     /// All other formatting macros ([`format!`], [`write!`], [`println!`], etc) are
 838     /// proxied through this one. `format_args!`, unlike its derived macros, avoids
 839     /// heap allocations.
 840     ///
 841     /// You can use the [`fmt::Arguments`] value that `format_args!` returns
 842     /// in `Debug` and `Display` contexts as seen below. The example also shows
 843     /// that `Debug` and `Display` format to the same thing: the interpolated
 844     /// format string in `format_args!`.
 845     ///
 846     /// ```rust
 847     /// let debug = format!("{:?}", format_args!("{} foo {:?}", 1, 2));
 848     /// let display = format!("{}", format_args!("{} foo {:?}", 1, 2));
 849     /// assert_eq!("1 foo 2", display);
 850     /// assert_eq!(display, debug);
 851     /// ```
 852     ///
 853     /// For more information, see the documentation in [`std::fmt`].
 854     ///
 855     /// [`Display`]: crate::fmt::Display
 856     /// [`Debug`]: crate::fmt::Debug
 857     /// [`fmt::Arguments`]: crate::fmt::Arguments
 858     /// [`std::fmt`]: ../std/fmt/index.html
 859     /// [`format!`]: ../std/macro.format.html
 860     /// [`println!`]: ../std/macro.println.html
 861     ///
 862     /// # Examples
 863     ///
 864     /// ```
 865     /// use std::fmt;
 866     ///
 867     /// let s = fmt::format(format_args!("hello {}", "world"));
 868     /// assert_eq!(s, format!("hello {}", "world"));
 869     /// ```
 870     #[stable(feature = "rust1", since = "1.0.0")]
 871     #[cfg_attr(not(test), rustc_diagnostic_item = "format_args_macro")]
 872     #[allow_internal_unsafe]
 873     #[allow_internal_unstable(fmt_internals)]
 874     #[rustc_builtin_macro]
 875     #[macro_export]
 876     macro_rules! format_args {
 877         ($fmt:expr) => {{ /* compiler built-in */ }};
 878         ($fmt:expr, $($args:tt)*) => {{ /* compiler built-in */ }};
 879     }
 880
 881     /// Same as [`format_args`], but can be used in some const contexts.
 882     ///
 883     /// This macro is used by the panic macros for the `const_panic` feature.
 884     ///
 885     /// This macro will be removed once `format_args` is allowed in const contexts.
 886     #[unstable(feature = "const_format_args", issue = "none")]
 887     #[allow_internal_unstable(fmt_internals, const_fmt_arguments_new)]
 888     #[rustc_builtin_macro]
 889     #[macro_export]
 890     macro_rules! const_format_args {
 891         ($fmt:expr) => {{ /* compiler built-in */ }};
 892         ($fmt:expr, $($args:tt)*) => {{ /* compiler built-in */ }};
 893     }
 894
 895     /// Same as [`format_args`], but adds a newline in the end.
 896     #[unstable(
 897         feature = "format_args_nl",
 898         issue = "none",
 899         reason = "`format_args_nl` is only for internal \
 900                   language use and is subject to change"
 901     )]
 902     #[allow_internal_unstable(fmt_internals)]
 903     #[rustc_builtin_macro]
 904     #[macro_export]
 905     macro_rules! format_args_nl {
 906         ($fmt:expr) => {{ /* compiler built-in */ }};
 907         ($fmt:expr, $($args:tt)*) => {{ /* compiler built-in */ }};
 908     }
 909
 910     /// Inspects an environment variable at compile time.
 911     ///
 912     /// This macro will expand to the value of the named environment variable at
 913     /// compile time, yielding an expression of type `&'static str`. Use
 914     /// [`std::env::var`] instead if you want to read the value at runtime.
 915     ///
 916     /// [`std::env::var`]: ../std/env/fn.var.html
 917     ///
 918     /// If the environment variable is not defined, then a compilation error
 919     /// will be emitted. To not emit a compile error, use the [`option_env!`]
 920     /// macro instead.
 921     ///
 922     /// # Examples
 923     ///
 924     /// ```
 925     /// let path: &'static str = env!("PATH");
 926     /// println!("the $PATH variable at the time of compiling was: {path}");
 927     /// ```
 928     ///
 929     /// You can customize the error message by passing a string as the second
 930     /// parameter:
 931     ///
 932     /// ```compile_fail
 933     /// let doc: &'static str = env!("documentation", "what's that?!");
 934     /// ```
 935     ///
 936     /// If the `documentation` environment variable is not defined, you'll get
 937     /// the following error:
 938     ///
 939     /// ```text
 940     /// error: what's that?!
 941     /// ```
 942     #[stable(feature = "rust1", since = "1.0.0")]
 943     #[rustc_builtin_macro]
 944     #[macro_export]
 945     macro_rules! env {
 946         ($name:expr $(,)?) => {{ /* compiler built-in */ }};
 947         ($name:expr, $error_msg:expr $(,)?) => {{ /* compiler built-in */ }};
 948     }
 949
 950     /// Optionally inspects an environment variable at compile time.
 951     ///
 952     /// If the named environment variable is present at compile time, this will
 953     /// expand into an expression of type `Option<&'static str>` whose value is
 954     /// `Some` of the value of the environment variable. If the environment
 955     /// variable is not present, then this will expand to `None`. See
 956     /// [`Option<T>`][Option] for more information on this type.  Use
 957     /// [`std::env::var`] instead if you want to read the value at runtime.
 958     ///
 959     /// [`std::env::var`]: ../std/env/fn.var.html
 960     ///
 961     /// A compile time error is never emitted when using this macro regardless
 962     /// of whether the environment variable is present or not.
 963     ///
 964     /// # Examples
 965     ///
 966     /// ```
 967     /// let key: Option<&'static str> = option_env!("SECRET_KEY");
 968     /// println!("the secret key might be: {key:?}");
 969     /// ```
 970     #[stable(feature = "rust1", since = "1.0.0")]
 971     #[rustc_builtin_macro]
 972     #[macro_export]
 973     macro_rules! option_env {
 974         ($name:expr $(,)?) => {{ /* compiler built-in */ }};
 975     }
 976
 977     /// Concatenates identifiers into one identifier.
 978     ///
 979     /// This macro takes any number of comma-separated identifiers, and
 980     /// concatenates them all into one, yielding an expression which is a new
 981     /// identifier. Note that hygiene makes it such that this macro cannot
 982     /// capture local variables. Also, as a general rule, macros are only
 983     /// allowed in item, statement or expression position. That means while
 984     /// you may use this macro for referring to existing variables, functions or
 985     /// modules etc, you cannot define a new one with it.
 986     ///
 987     /// # Examples
 988     ///
 989     /// ```
 990     /// #![feature(concat_idents)]
 991     ///
 992     /// # fn main() {
 993     /// fn foobar() -> u32 { 23 }
 994     ///
 995     /// let f = concat_idents!(foo, bar);
 996     /// println!("{}", f());
 997     ///
 998     /// // fn concat_idents!(new, fun, name) { } // not usable in this way!
 999     /// # }
1000     /// ```
1001     #[unstable(
1002         feature = "concat_idents",
1003         issue = "29599",
1004         reason = "`concat_idents` is not stable enough for use and is subject to change"
1005     )]
1006     #[rustc_builtin_macro]
1007     #[macro_export]
1008     macro_rules! concat_idents {
1009         ($($e:ident),+ $(,)?) => {{ /* compiler built-in */ }};
1010     }
1011
1012     /// Concatenates literals into a byte slice.
1013     ///
1014     /// This macro takes any number of comma-separated literals, and concatenates them all into
1015     /// one, yielding an expression of type `&[u8; _]`, which represents all of the literals
1016     /// concatenated left-to-right. The literals passed can be any combination of:
1017     ///
1018     /// - byte literals (`b'r'`)
1019     /// - byte strings (`b"Rust"`)
1020     /// - arrays of bytes/numbers (`[b'A', 66, b'C']`)
1021     ///
1022     /// # Examples
1023     ///
1024     /// ```
1025     /// #![feature(concat_bytes)]
1026     ///
1027     /// # fn main() {
1028     /// let s: &[u8; 6] = concat_bytes!(b'A', b"BC", [68, b'E', 70]);
1029     /// assert_eq!(s, b"ABCDEF");
1030     /// # }
1031     /// ```
1032     #[unstable(feature = "concat_bytes", issue = "87555")]
1033     #[rustc_builtin_macro]
1034     #[macro_export]
1035     macro_rules! concat_bytes {
1036         ($($e:literal),+ $(,)?) => {{ /* compiler built-in */ }};
1037     }
1038
1039     /// Concatenates literals into a static string slice.
1040     ///
1041     /// This macro takes any number of comma-separated literals, yielding an
1042     /// expression of type `&'static str` which represents all of the literals
1043     /// concatenated left-to-right.
1044     ///
1045     /// Integer and floating point literals are stringified in order to be
1046     /// concatenated.
1047     ///
1048     /// # Examples
1049     ///
1050     /// ```
1051     /// let s = concat!("test", 10, 'b', true);
1052     /// assert_eq!(s, "test10btrue");
1053     /// ```
1054     #[stable(feature = "rust1", since = "1.0.0")]
1055     #[rustc_builtin_macro]
1056     #[macro_export]
1057     macro_rules! concat {
1058         ($($e:expr),* $(,)?) => {{ /* compiler built-in */ }};
1059     }
1060
1061     /// Expands to the line number on which it was invoked.
1062     ///
1063     /// With [`column!`] and [`file!`], these macros provide debugging information for
1064     /// developers about the location within the source.
1065     ///
1066     /// The expanded expression has type `u32` and is 1-based, so the first line
1067     /// in each file evaluates to 1, the second to 2, etc. This is consistent
1068     /// with error messages by common compilers or popular editors.
1069     /// The returned line is *not necessarily* the line of the `line!` invocation itself,
1070     /// but rather the first macro invocation leading up to the invocation
1071     /// of the `line!` macro.
1072     ///
1073     /// # Examples
1074     ///
1075     /// ```
1076     /// let current_line = line!();
1077     /// println!("defined on line: {current_line}");
1078     /// ```
1079     #[stable(feature = "rust1", since = "1.0.0")]
1080     #[rustc_builtin_macro]
1081     #[macro_export]
1082     macro_rules! line {
1083         () => {
1084             /* compiler built-in */
1085         };
1086     }
1087
1088     /// Expands to the column number at which it was invoked.
1089     ///
1090     /// With [`line!`] and [`file!`], these macros provide debugging information for
1091     /// developers about the location within the source.
1092     ///
1093     /// The expanded expression has type `u32` and is 1-based, so the first column
1094     /// in each line evaluates to 1, the second to 2, etc. This is consistent
1095     /// with error messages by common compilers or popular editors.
1096     /// The returned column is *not necessarily* the line of the `column!` invocation itself,
1097     /// but rather the first macro invocation leading up to the invocation
1098     /// of the `column!` macro.
1099     ///
1100     /// # Examples
1101     ///
1102     /// ```
1103     /// let current_col = column!();
1104     /// println!("defined on column: {current_col}");
1105     /// ```
1106     ///
1107     /// `column!` counts Unicode code points, not bytes or graphemes. As a result, the first two
1108     /// invocations return the same value, but the third does not.
1109     ///
1110     /// ```
1111     /// let a = ("foobar", column!()).1;
1112     /// let b = ("人之初性本善", column!()).1;
1113     /// let c = ("f̅o̅o̅b̅a̅r̅", column!()).1; // Uses combining overline (U+0305)
1114     ///
1115     /// assert_eq!(a, b);
1116     /// assert_ne!(b, c);
1117     /// ```
1118     #[stable(feature = "rust1", since = "1.0.0")]
1119     #[rustc_builtin_macro]
1120     #[macro_export]
1121     macro_rules! column {
1122         () => {
1123             /* compiler built-in */
1124         };
1125     }
1126
1127     /// Expands to the file name in which it was invoked.
1128     ///
1129     /// With [`line!`] and [`column!`], these macros provide debugging information for
1130     /// developers about the location within the source.
1131     ///
1132     /// The expanded expression has type `&'static str`, and the returned file
1133     /// is not the invocation of the `file!` macro itself, but rather the
1134     /// first macro invocation leading up to the invocation of the `file!`
1135     /// macro.
1136     ///
1137     /// # Examples
1138     ///
1139     /// ```
1140     /// let this_file = file!();
1141     /// println!("defined in file: {this_file}");
1142     /// ```
1143     #[stable(feature = "rust1", since = "1.0.0")]
1144     #[rustc_builtin_macro]
1145     #[macro_export]
1146     macro_rules! file {
1147         () => {
1148             /* compiler built-in */
1149         };
1150     }
1151
1152     /// Stringifies its arguments.
1153     ///
1154     /// This macro will yield an expression of type `&'static str` which is the
1155     /// stringification of all the tokens passed to the macro. No restrictions
1156     /// are placed on the syntax of the macro invocation itself.
1157     ///
1158     /// Note that the expanded results of the input tokens may change in the
1159     /// future. You should be careful if you rely on the output.
1160     ///
1161     /// # Examples
1162     ///
1163     /// ```
1164     /// let one_plus_one = stringify!(1 + 1);
1165     /// assert_eq!(one_plus_one, "1 + 1");
1166     /// ```
1167     #[stable(feature = "rust1", since = "1.0.0")]
1168     #[rustc_builtin_macro]
1169     #[macro_export]
1170     macro_rules! stringify {
1171         ($($t:tt)*) => {
1172             /* compiler built-in */
1173         };
1174     }
1175
1176     /// Includes a UTF-8 encoded file as a string.
1177     ///
1178     /// The file is located relative to the current file (similarly to how
1179     /// modules are found). The provided path is interpreted in a platform-specific
1180     /// way at compile time. So, for instance, an invocation with a Windows path
1181     /// containing backslashes `\` would not compile correctly on Unix.
1182     ///
1183     /// This macro will yield an expression of type `&'static str` which is the
1184     /// contents of the file.
1185     ///
1186     /// # Examples
1187     ///
1188     /// Assume there are two files in the same directory with the following
1189     /// contents:
1190     ///
1191     /// File 'spanish.in':
1192     ///
1193     /// ```text
1194     /// adiós
1195     /// ```
1196     ///
1197     /// File 'main.rs':
1198     ///
1199     /// ```ignore (cannot-doctest-external-file-dependency)
1200     /// fn main() {
1201     ///     let my_str = include_str!("spanish.in");
1202     ///     assert_eq!(my_str, "adiós\n");
1203     ///     print!("{my_str}");
1204     /// }
1205     /// ```
1206     ///
1207     /// Compiling 'main.rs' and running the resulting binary will print "adiós".
1208     #[stable(feature = "rust1", since = "1.0.0")]
1209     #[rustc_builtin_macro]
1210     #[macro_export]
1211     #[cfg_attr(not(test), rustc_diagnostic_item = "include_str_macro")]
1212     macro_rules! include_str {
1213         ($file:expr $(,)?) => {{ /* compiler built-in */ }};
1214     }
1215
1216     /// Includes a file as a reference to a byte array.
1217     ///
1218     /// The file is located relative to the current file (similarly to how
1219     /// modules are found). The provided path is interpreted in a platform-specific
1220     /// way at compile time. So, for instance, an invocation with a Windows path
1221     /// containing backslashes `\` would not compile correctly on Unix.
1222     ///
1223     /// This macro will yield an expression of type `&'static [u8; N]` which is
1224     /// the contents of the file.
1225     ///
1226     /// # Examples
1227     ///
1228     /// Assume there are two files in the same directory with the following
1229     /// contents:
1230     ///
1231     /// File 'spanish.in':
1232     ///
1233     /// ```text
1234     /// adiós
1235     /// ```
1236     ///
1237     /// File 'main.rs':
1238     ///
1239     /// ```ignore (cannot-doctest-external-file-dependency)
1240     /// fn main() {
1241     ///     let bytes = include_bytes!("spanish.in");
1242     ///     assert_eq!(bytes, b"adi\xc3\xb3s\n");
1243     ///     print!("{}", String::from_utf8_lossy(bytes));
1244     /// }
1245     /// ```
1246     ///
1247     /// Compiling 'main.rs' and running the resulting binary will print "adiós".
1248     #[stable(feature = "rust1", since = "1.0.0")]
1249     #[rustc_builtin_macro]
1250     #[macro_export]
1251     #[cfg_attr(not(test), rustc_diagnostic_item = "include_bytes_macro")]
1252     macro_rules! include_bytes {
1253         ($file:expr $(,)?) => {{ /* compiler built-in */ }};
1254     }
1255
1256     /// Expands to a string that represents the current module path.
1257     ///
1258     /// The current module path can be thought of as the hierarchy of modules
1259     /// leading back up to the crate root. The first component of the path
1260     /// returned is the name of the crate currently being compiled.
1261     ///
1262     /// # Examples
1263     ///
1264     /// ```
1265     /// mod test {
1266     ///     pub fn foo() {
1267     ///         assert!(module_path!().ends_with("test"));
1268     ///     }
1269     /// }
1270     ///
1271     /// test::foo();
1272     /// ```
1273     #[stable(feature = "rust1", since = "1.0.0")]
1274     #[rustc_builtin_macro]
1275     #[macro_export]
1276     macro_rules! module_path {
1277         () => {
1278             /* compiler built-in */
1279         };
1280     }
1281
1282     /// Evaluates boolean combinations of configuration flags at compile-time.
1283     ///
1284     /// In addition to the `#[cfg]` attribute, this macro is provided to allow
1285     /// boolean expression evaluation of configuration flags. This frequently
1286     /// leads to less duplicated code.
1287     ///
1288     /// The syntax given to this macro is the same syntax as the [`cfg`]
1289     /// attribute.
1290     ///
1291     /// `cfg!`, unlike `#[cfg]`, does not remove any code and only evaluates to true or false. For
1292     /// example, all blocks in an if/else expression need to be valid when `cfg!` is used for
1293     /// the condition, regardless of what `cfg!` is evaluating.
1294     ///
1295     /// [`cfg`]: ../reference/conditional-compilation.html#the-cfg-attribute
1296     ///
1297     /// # Examples
1298     ///
1299     /// ```
1300     /// let my_directory = if cfg!(windows) {
1301     ///     "windows-specific-directory"
1302     /// } else {
1303     ///     "unix-directory"
1304     /// };
1305     /// ```
1306     #[stable(feature = "rust1", since = "1.0.0")]
1307     #[rustc_builtin_macro]
1308     #[macro_export]
1309     macro_rules! cfg {
1310         ($($cfg:tt)*) => {
1311             /* compiler built-in */
1312         };
1313     }
1314
1315     /// Parses a file as an expression or an item according to the context.
1316     ///
1317     /// The file is located relative to the current file (similarly to how
1318     /// modules are found). The provided path is interpreted in a platform-specific
1319     /// way at compile time. So, for instance, an invocation with a Windows path
1320     /// containing backslashes `\` would not compile correctly on Unix.
1321     ///
1322     /// Using this macro is often a bad idea, because if the file is
1323     /// parsed as an expression, it is going to be placed in the
1324     /// surrounding code unhygienically. This could result in variables
1325     /// or functions being different from what the file expected if
1326     /// there are variables or functions that have the same name in
1327     /// the current file.
1328     ///
1329     /// # Examples
1330     ///
1331     /// Assume there are two files in the same directory with the following
1332     /// contents:
1333     ///
1334     /// File 'monkeys.in':
1335     ///
1336     /// ```ignore (only-for-syntax-highlight)
1337     /// ['🙈', '🙊', '🙉']
1338     ///     .iter()
1339     ///     .cycle()
1340     ///     .take(6)
1341     ///     .collect::<String>()
1342     /// ```
1343     ///
1344     /// File 'main.rs':
1345     ///
1346     /// ```ignore (cannot-doctest-external-file-dependency)
1347     /// fn main() {
1348     ///     let my_string = include!("monkeys.in");
1349     ///     assert_eq!("🙈🙊🙉🙈🙊🙉", my_string);
1350     ///     println!("{my_string}");
1351     /// }
1352     /// ```
1353     ///
1354     /// Compiling 'main.rs' and running the resulting binary will print
1355     /// "🙈🙊🙉🙈🙊🙉".
1356     #[stable(feature = "rust1", since = "1.0.0")]
1357     #[rustc_builtin_macro]
1358     #[macro_export]
1359     macro_rules! include {
1360         ($file:expr $(,)?) => {{ /* compiler built-in */ }};
1361     }
1362
1363     /// Asserts that a boolean expression is `true` at runtime.
1364     ///
1365     /// This will invoke the [`panic!`] macro if the provided expression cannot be
1366     /// evaluated to `true` at runtime.
1367     ///
1368     /// # Uses
1369     ///
1370     /// Assertions are always checked in both debug and release builds, and cannot
1371     /// be disabled. See [`debug_assert!`] for assertions that are not enabled in
1372     /// release builds by default.
1373     ///
1374     /// Unsafe code may rely on `assert!` to enforce run-time invariants that, if
1375     /// violated could lead to unsafety.
1376     ///
1377     /// Other use-cases of `assert!` include testing and enforcing run-time
1378     /// invariants in safe code (whose violation cannot result in unsafety).
1379     ///
1380     /// # Custom Messages
1381     ///
1382     /// This macro has a second form, where a custom panic message can
1383     /// be provided with or without arguments for formatting. See [`std::fmt`]
1384     /// for syntax for this form. Expressions used as format arguments will only
1385     /// be evaluated if the assertion fails.
1386     ///
1387     /// [`std::fmt`]: ../std/fmt/index.html
1388     ///
1389     /// # Examples
1390     ///
1391     /// ```
1392     /// // the panic message for these assertions is the stringified value of the
1393     /// // expression given.
1394     /// assert!(true);
1395     ///
1396     /// fn some_computation() -> bool { true } // a very simple function
1397     ///
1398     /// assert!(some_computation());
1399     ///
1400     /// // assert with a custom message
1401     /// let x = true;
1402     /// assert!(x, "x wasn't true!");
1403     ///
1404     /// let a = 3; let b = 27;
1405     /// assert!(a + b == 30, "a = {}, b = {}", a, b);
1406     /// ```
1407     #[stable(feature = "rust1", since = "1.0.0")]
1408     #[rustc_builtin_macro]
1409     #[macro_export]
1410     #[rustc_diagnostic_item = "assert_macro"]
1411     #[allow_internal_unstable(core_panic, edition_panic)]
1412     macro_rules! assert {
1413         ($cond:expr $(,)?) => {{ /* compiler built-in */ }};
1414         ($cond:expr, $($arg:tt)+) => {{ /* compiler built-in */ }};
1415     }
1416
1417     /// Prints passed tokens into the standard output.
1418     #[unstable(
1419         feature = "log_syntax",
1420         issue = "29598",
1421         reason = "`log_syntax!` is not stable enough for use and is subject to change"
1422     )]
1423     #[rustc_builtin_macro]
1424     #[macro_export]
1425     macro_rules! log_syntax {
1426         ($($arg:tt)*) => {
1427             /* compiler built-in */
1428         };
1429     }
1430
1431     /// Enables or disables tracing functionality used for debugging other macros.
1432     #[unstable(
1433         feature = "trace_macros",
1434         issue = "29598",
1435         reason = "`trace_macros` is not stable enough for use and is subject to change"
1436     )]
1437     #[rustc_builtin_macro]
1438     #[macro_export]
1439     macro_rules! trace_macros {
1440         (true) => {{ /* compiler built-in */ }};
1441         (false) => {{ /* compiler built-in */ }};
1442     }
1443
1444     /// Attribute macro used to apply derive macros.
1445     ///
1446     /// See [the reference] for more info.
1447     ///
1448     /// [the reference]: ../../../reference/attributes/derive.html
1449     #[stable(feature = "rust1", since = "1.0.0")]
1450     #[rustc_builtin_macro]
1451     pub macro derive($item:item) {
1452         /* compiler built-in */
1453     }
1454
1455     /// Attribute macro used to apply derive macros for implementing traits
1456     /// in a const context.
1457     ///
1458     /// See [the reference] for more info.
1459     ///
1460     /// [the reference]: ../../../reference/attributes/derive.html
1461     #[unstable(feature = "derive_const", issue = "none")]
1462     #[rustc_builtin_macro]
1463     #[cfg(not(bootstrap))]
1464     pub macro derive_const($item:item) {
1465         /* compiler built-in */
1466     }
1467
1468     /// Attribute macro applied to a function to turn it into a unit test.
1469     ///
1470     /// See [the reference] for more info.
1471     ///
1472     /// [the reference]: ../../../reference/attributes/testing.html#the-test-attribute
1473     #[stable(feature = "rust1", since = "1.0.0")]
1474     #[allow_internal_unstable(test, rustc_attrs)]
1475     #[rustc_builtin_macro]
1476     pub macro test($item:item) {
1477         /* compiler built-in */
1478     }
1479
1480     /// Attribute macro applied to a function to turn it into a benchmark test.
1481     #[unstable(
1482         feature = "test",
1483         issue = "50297",
1484         soft,
1485         reason = "`bench` is a part of custom test frameworks which are unstable"
1486     )]
1487     #[allow_internal_unstable(test, rustc_attrs)]
1488     #[rustc_builtin_macro]
1489     pub macro bench($item:item) {
1490         /* compiler built-in */
1491     }
1492
1493     /// An implementation detail of the `#[test]` and `#[bench]` macros.
1494     #[unstable(
1495         feature = "custom_test_frameworks",
1496         issue = "50297",
1497         reason = "custom test frameworks are an unstable feature"
1498     )]
1499     #[allow_internal_unstable(test, rustc_attrs)]
1500     #[rustc_builtin_macro]
1501     pub macro test_case($item:item) {
1502         /* compiler built-in */
1503     }
1504
1505     /// Attribute macro applied to a static to register it as a global allocator.
1506     ///
1507     /// See also [`std::alloc::GlobalAlloc`](../../../std/alloc/trait.GlobalAlloc.html).
1508     #[stable(feature = "global_allocator", since = "1.28.0")]
1509     #[allow_internal_unstable(rustc_attrs)]
1510     #[rustc_builtin_macro]
1511     pub macro global_allocator($item:item) {
1512         /* compiler built-in */
1513     }
1514
1515     /// Attribute macro applied to a function to register it as a handler for allocation failure.
1516     ///
1517     /// See also [`std::alloc::handle_alloc_error`](../../../std/alloc/fn.handle_alloc_error.html).
1518     #[cfg(not(bootstrap))]
1519     #[unstable(feature = "alloc_error_handler", issue = "51540")]
1520     #[allow_internal_unstable(rustc_attrs)]
1521     #[rustc_builtin_macro]
1522     pub macro alloc_error_handler($item:item) {
1523         /* compiler built-in */
1524     }
1525
1526     /// Keeps the item it's applied to if the passed path is accessible, and removes it otherwise.
1527     #[unstable(
1528         feature = "cfg_accessible",
1529         issue = "64797",
1530         reason = "`cfg_accessible` is not fully implemented"
1531     )]
1532     #[rustc_builtin_macro]
1533     pub macro cfg_accessible($item:item) {
1534         /* compiler built-in */
1535     }
1536
1537     /// Expands all `#[cfg]` and `#[cfg_attr]` attributes in the code fragment it's applied to.
1538     #[unstable(
1539         feature = "cfg_eval",
1540         issue = "82679",
1541         reason = "`cfg_eval` is a recently implemented feature"
1542     )]
1543     #[rustc_builtin_macro]
1544     pub macro cfg_eval($($tt:tt)*) {
1545         /* compiler built-in */
1546     }
1547
1548     /// Unstable implementation detail of the `rustc` compiler, do not use.
1549     #[rustc_builtin_macro]
1550     #[stable(feature = "rust1", since = "1.0.0")]
1551     #[allow_internal_unstable(core_intrinsics, libstd_sys_internals, rt)]
1552     #[deprecated(since = "1.52.0", note = "rustc-serialize is deprecated and no longer supported")]
1553     #[doc(hidden)] // While technically stable, using it is unstable, and deprecated. Hide it.
1554     pub macro RustcDecodable($item:item) {
1555         /* compiler built-in */
1556     }
1557
1558     /// Unstable implementation detail of the `rustc` compiler, do not use.
1559     #[rustc_builtin_macro]
1560     #[stable(feature = "rust1", since = "1.0.0")]
1561     #[allow_internal_unstable(core_intrinsics, rt)]
1562     #[deprecated(since = "1.52.0", note = "rustc-serialize is deprecated and no longer supported")]
1563     #[doc(hidden)] // While technically stable, using it is unstable, and deprecated. Hide it.
1564     pub macro RustcEncodable($item:item) {
1565         /* compiler built-in */
1566     }
1567 }