src/libstd/macros.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 //! Standard library macros
  12 //!
  13 //! This modules contains a set of macros which are exported from the standard
  14 //! library. Each macro is available for use when linking against the standard
  15 //! library.
  16
  17 /// The entry point for panic of Rust threads.
  18 ///
  19 /// This allows a program to to terminate immediately and provide feedback
  20 /// to the caller of the program. `panic!` should be used when a program reaches
  21 /// an unrecoverable problem.
  22 ///
  23 /// This macro is the perfect way to assert conditions in example code and in
  24 /// tests.  `panic!` is closely tied with the `unwrap` method of both [`Option`]
  25 /// and [`Result`][runwrap] enums.  Both implementations call `panic!` when they are set
  26 /// to None or Err variants.
  27 ///
  28 /// This macro is used to inject panic into a Rust thread, causing the thread to
  29 /// panic entirely. Each thread's panic can be reaped as the `Box<Any>` type,
  30 /// and the single-argument form of the `panic!` macro will be the value which
  31 /// is transmitted.
  32 ///
  33 /// [`Result`] enum is often a better solution for recovering from errors than
  34 /// using the `panic!` macro.  This macro should be used to avoid proceeding using
  35 /// incorrect values, such as from external sources.  Detailed information about
  36 /// error handling is found in the [book].
  37 ///
  38 /// The multi-argument form of this macro panics with a string and has the
  39 /// [`format!`] syntax for building a string.
  40 ///
  41 /// See also the macro [`compile_error!`], for raising errors during compilation.
  42 ///
  43 /// [runwrap]: ../std/result/enum.Result.html#method.unwrap
  44 /// [`Option`]: ../std/option/enum.Option.html#method.unwrap
  45 /// [`Result`]: ../std/result/enum.Result.html
  46 /// [`format!`]: ../std/macro.format.html
  47 /// [`compile_error!`]: ../std/macro.compile_error.html
  48 /// [book]: ../book/second-edition/ch09-01-unrecoverable-errors-with-panic.html
  49 ///
  50 /// # Current implementation
  51 ///
  52 /// If the main thread panics it will terminate all your threads and end your
  53 /// program with code `101`.
  54 ///
  55 /// # Examples
  56 ///
  57 /// ```should_panic
  58 /// # #![allow(unreachable_code)]
  59 /// panic!();
  60 /// panic!("this is a terrible mistake!");
  61 /// panic!(4); // panic with the value of 4 to be collected elsewhere
  62 /// panic!("this is a {} {message}", "fancy", message = "message");
  63 /// ```
  64 #[macro_export]
  65 #[stable(feature = "rust1", since = "1.0.0")]
  66 #[allow_internal_unstable]
  67 macro_rules! panic {
  68     () => ({
  69         panic!("explicit panic")
  70     });
  71     ($msg:expr) => ({
  72         $crate::rt::begin_panic($msg, &(file!(), line!(), __rust_unstable_column!()))
  73     });
  74     ($msg:expr,) => ({
  75         panic!($msg)
  76     });
  77     ($fmt:expr, $($arg:tt)+) => ({
  78         $crate::rt::begin_panic_fmt(&format_args!($fmt, $($arg)+),
  79                                     &(file!(), line!(), __rust_unstable_column!()))
  80     });
  81 }
  82
  83 /// Macro for printing to the standard output.
  84 ///
  85 /// Equivalent to the [`println!`] macro except that a newline is not printed at
  86 /// the end of the message.
  87 ///
  88 /// Note that stdout is frequently line-buffered by default so it may be
  89 /// necessary to use [`io::stdout().flush()`][flush] to ensure the output is emitted
  90 /// immediately.
  91 ///
  92 /// Use `print!` only for the primary output of your program.  Use
  93 /// [`eprint!`] instead to print error and progress messages.
  94 ///
  95 /// [`println!`]: ../std/macro.println.html
  96 /// [flush]: ../std/io/trait.Write.html#tymethod.flush
  97 /// [`eprint!`]: ../std/macro.eprint.html
  98 ///
  99 /// # Panics
 100 ///
 101 /// Panics if writing to `io::stdout()` fails.
 102 ///
 103 /// # Examples
 104 ///
 105 /// ```
 106 /// use std::io::{self, Write};
 107 ///
 108 /// print!("this ");
 109 /// print!("will ");
 110 /// print!("be ");
 111 /// print!("on ");
 112 /// print!("the ");
 113 /// print!("same ");
 114 /// print!("line ");
 115 ///
 116 /// io::stdout().flush().unwrap();
 117 ///
 118 /// print!("this string has a newline, why not choose println! instead?\n");
 119 ///
 120 /// io::stdout().flush().unwrap();
 121 /// ```
 122 #[macro_export]
 123 #[stable(feature = "rust1", since = "1.0.0")]
 124 #[allow_internal_unstable]
 125 macro_rules! print {
 126     ($($arg:tt)*) => ($crate::io::_print(format_args!($($arg)*)));
 127 }
 128
 129 /// Macro for printing to the standard output, with a newline.
 130 ///
 131 /// On all platforms, the newline is the LINE FEED character (`\n`/`U+000A`) alone
 132 /// (no additional CARRIAGE RETURN (`\r`/`U+000D`).
 133 ///
 134 /// Use the [`format!`] syntax to write data to the standard output.
 135 /// See [`std::fmt`] for more information.
 136 ///
 137 /// Use `println!` only for the primary output of your program.  Use
 138 /// [`eprintln!`] instead to print error and progress messages.
 139 ///
 140 /// [`format!`]: ../std/macro.format.html
 141 /// [`std::fmt`]: ../std/fmt/index.html
 142 /// [`eprintln!`]: ../std/macro.eprint.html
 143 /// # Panics
 144 ///
 145 /// Panics if writing to `io::stdout` fails.
 146 ///
 147 /// # Examples
 148 ///
 149 /// ```
 150 /// println!(); // prints just a newline
 151 /// println!("hello there!");
 152 /// println!("format {} arguments", "some");
 153 /// ```
 154 #[macro_export]
 155 #[stable(feature = "rust1", since = "1.0.0")]
 156 #[allow_internal_unstable]
 157 macro_rules! println {
 158     () => (print!("\n"));
 159     ($($arg:tt)*) => ({
 160         $crate::io::_print(format_args_nl!($($arg)*));
 161     })
 162 }
 163
 164 /// Macro for printing to the standard error.
 165 ///
 166 /// Equivalent to the [`print!`] macro, except that output goes to
 167 /// [`io::stderr`] instead of `io::stdout`.  See [`print!`] for
 168 /// example usage.
 169 ///
 170 /// Use `eprint!` only for error and progress messages.  Use `print!`
 171 /// instead for the primary output of your program.
 172 ///
 173 /// [`io::stderr`]: ../std/io/struct.Stderr.html
 174 /// [`print!`]: ../std/macro.print.html
 175 ///
 176 /// # Panics
 177 ///
 178 /// Panics if writing to `io::stderr` fails.
 179 ///
 180 /// # Examples
 181 ///
 182 /// ```
 183 /// eprint!("Error: Could not complete task");
 184 /// ```
 185 #[macro_export]
 186 #[stable(feature = "eprint", since = "1.19.0")]
 187 #[allow_internal_unstable]
 188 macro_rules! eprint {
 189     ($($arg:tt)*) => ($crate::io::_eprint(format_args!($($arg)*)));
 190 }
 191
 192 /// Macro for printing to the standard error, with a newline.
 193 ///
 194 /// Equivalent to the [`println!`] macro, except that output goes to
 195 /// [`io::stderr`] instead of `io::stdout`.  See [`println!`] for
 196 /// example usage.
 197 ///
 198 /// Use `eprintln!` only for error and progress messages.  Use `println!`
 199 /// instead for the primary output of your program.
 200 ///
 201 /// [`io::stderr`]: ../std/io/struct.Stderr.html
 202 /// [`println!`]: ../std/macro.println.html
 203 ///
 204 /// # Panics
 205 ///
 206 /// Panics if writing to `io::stderr` fails.
 207 ///
 208 /// # Examples
 209 ///
 210 /// ```
 211 /// eprintln!("Error: Could not complete task");
 212 /// ```
 213 #[macro_export]
 214 #[stable(feature = "eprint", since = "1.19.0")]
 215 #[allow_internal_unstable]
 216 macro_rules! eprintln {
 217     () => (eprint!("\n"));
 218     ($($arg:tt)*) => ({
 219         $crate::io::_eprint(format_args_nl!($($arg)*));
 220     })
 221 }
 222
 223 /// A macro for quick and dirty debugging with which you can inspect
 224 /// the value of a given expression. An example:
 225 ///
 226 /// ```rust
 227 /// #![feature(dbg_macro)]
 228 ///
 229 /// let a = 2;
 230 /// let b = dbg!(a * 2) + 1;
 231 /// //      ^-- prints: [src/main.rs:4] a * 2 = 4
 232 /// assert_eq!(b, 5);
 233 /// ```
 234 ///
 235 /// The macro works by using the `Debug` implementation of the type of
 236 /// the given expression to print the value to [stderr] along with the
 237 /// source location of the macro invocation as well as the source code
 238 /// of the expression.
 239 ///
 240 /// Invoking the macro on an expression moves and takes ownership of it
 241 /// before returning the evaluated expression unchanged. If the type
 242 /// of the expression does not implement `Copy` and you don't want
 243 /// to give up ownership, you can instead borrow with `dbg!(&expr)`
 244 /// for some expression `expr`.
 245 ///
 246 /// Note that the macro is intended as a debugging tool and therefore you
 247 /// should avoid having uses of it in version control for longer periods.
 248 /// Use cases involving debug output that should be added to version control
 249 /// may be better served by macros such as `debug!` from the `log` crate.
 250 ///
 251 /// # Stability
 252 ///
 253 /// The exact output printed by this macro should not be relied upon
 254 /// and is subject to future changes.
 255 ///
 256 /// # Panics
 257 ///
 258 /// Panics if writing to `io::stderr` fails.
 259 ///
 260 /// # Further examples
 261 ///
 262 /// With a method call:
 263 ///
 264 /// ```rust
 265 /// #![feature(dbg_macro)]
 266 ///
 267 /// fn foo(n: usize) {
 268 ///     if let Some(_) = dbg!(n.checked_sub(4)) {
 269 ///         // ...
 270 ///     }
 271 /// }
 272 ///
 273 /// foo(3)
 274 /// ```
 275 ///
 276 /// This prints to [stderr]:
 277 ///
 278 /// ```text,ignore
 279 /// [src/main.rs:4] n.checked_sub(4) = None
 280 /// ```
 281 ///
 282 /// Naive factorial implementation:
 283 ///
 284 /// ```rust
 285 /// #![feature(dbg_macro)]
 286 ///
 287 /// fn factorial(n: u32) -> u32 {
 288 ///     if dbg!(n <= 1) {
 289 ///         dbg!(1)
 290 ///     } else {
 291 ///         dbg!(n * factorial(n - 1))
 292 ///     }
 293 /// }
 294 ///
 295 /// dbg!(factorial(4));
 296 /// ```
 297 ///
 298 /// This prints to [stderr]:
 299 ///
 300 /// ```text,ignore
 301 /// [src/main.rs:3] n <= 1 = false
 302 /// [src/main.rs:3] n <= 1 = false
 303 /// [src/main.rs:3] n <= 1 = false
 304 /// [src/main.rs:3] n <= 1 = true
 305 /// [src/main.rs:4] 1 = 1
 306 /// [src/main.rs:5] n * factorial(n - 1) = 2
 307 /// [src/main.rs:5] n * factorial(n - 1) = 6
 308 /// [src/main.rs:5] n * factorial(n - 1) = 24
 309 /// [src/main.rs:11] factorial(4) = 24
 310 /// ```
 311 ///
 312 /// The `dbg!(..)` macro moves the input:
 313 ///
 314 /// ```compile_fail
 315 /// #![feature(dbg_macro)]
 316 ///
 317 /// /// A wrapper around `usize` which importantly is not Copyable.
 318 /// #[derive(Debug)]
 319 /// struct NoCopy(usize);
 320 ///
 321 /// let a = NoCopy(42);
 322 /// let _ = dbg!(a); // <-- `a` is moved here.
 323 /// let _ = dbg!(a); // <-- `a` is moved again; error!
 324 /// ```
 325 ///
 326 /// [stderr]: https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr)
 327 #[macro_export]
 328 #[unstable(feature = "dbg_macro", issue = "54306")]
 329 macro_rules! dbg {
 330     ($val:expr) => {
 331         // Use of `match` here is intentional because it affects the lifetimes
 332         // of temporaries - https://stackoverflow.com/a/48732525/1063961
 333         match $val {
 334             tmp => {
 335                 eprintln!("[{}:{}] {} = {:#?}",
 336                     file!(), line!(), stringify!($val), &tmp);
 337                 tmp
 338             }
 339         }
 340     }
 341 }
 342
 343 #[macro_export]
 344 #[unstable(feature = "await_macro", issue = "50547")]
 345 #[allow_internal_unstable]
 346 #[allow_internal_unsafe]
 347 macro_rules! await {
 348     ($e:expr) => { {
 349         let mut pinned = $e;
 350         loop {
 351             if let $crate::task::Poll::Ready(x) =
 352                 $crate::future::poll_in_task_cx(unsafe {
 353                     $crate::pin::Pin::new_unchecked(&mut pinned)
 354                 })
 355             {
 356                 break x;
 357             }
 358             // FIXME(cramertj) prior to stabilizing await, we have to ensure that this
 359             // can't be used to create a generator on stable via `|| await!()`.
 360             yield
 361         }
 362     } }
 363 }
 364
 365 /// A macro to select an event from a number of receivers.
 366 ///
 367 /// This macro is used to wait for the first event to occur on a number of
 368 /// receivers. It places no restrictions on the types of receivers given to
 369 /// this macro, this can be viewed as a heterogeneous select.
 370 ///
 371 /// # Examples
 372 ///
 373 /// ```
 374 /// #![feature(mpsc_select)]
 375 ///
 376 /// use std::thread;
 377 /// use std::sync::mpsc;
 378 ///
 379 /// // two placeholder functions for now
 380 /// fn long_running_thread() {}
 381 /// fn calculate_the_answer() -> u32 { 42 }
 382 ///
 383 /// let (tx1, rx1) = mpsc::channel();
 384 /// let (tx2, rx2) = mpsc::channel();
 385 ///
 386 /// thread::spawn(move|| { long_running_thread(); tx1.send(()).unwrap(); });
 387 /// thread::spawn(move|| { tx2.send(calculate_the_answer()).unwrap(); });
 388 ///
 389 /// select! {
 390 ///     _ = rx1.recv() => println!("the long running thread finished first"),
 391 ///     answer = rx2.recv() => {
 392 ///         println!("the answer was: {}", answer.unwrap());
 393 ///     }
 394 /// }
 395 /// # drop(rx1.recv());
 396 /// # drop(rx2.recv());
 397 /// ```
 398 ///
 399 /// For more information about select, see the `std::sync::mpsc::Select` structure.
 400 #[macro_export]
 401 #[unstable(feature = "mpsc_select", issue = "27800")]
 402 macro_rules! select {
 403     (
 404         $($name:pat = $rx:ident.$meth:ident() => $code:expr),+
 405     ) => ({
 406         use $crate::sync::mpsc::Select;
 407         let sel = Select::new();
 408         $( let mut $rx = sel.handle(&$rx); )+
 409         unsafe {
 410             $( $rx.add(); )+
 411         }
 412         let ret = sel.wait();
 413         $( if ret == $rx.id() { let $name = $rx.$meth(); $code } else )+
 414         { unreachable!() }
 415     })
 416 }
 417
 418 #[cfg(test)]
 419 macro_rules! assert_approx_eq {
 420     ($a:expr, $b:expr) => ({
 421         let (a, b) = (&$a, &$b);
 422         assert!((*a - *b).abs() < 1.0e-6,
 423                 "{} is not approximately equal to {}", *a, *b);
 424     })
 425 }
 426
 427 /// Built-in macros to the compiler itself.
 428 ///
 429 /// These macros do not have any corresponding definition with a `macro_rules!`
 430 /// macro, but are documented here. Their implementations can be found hardcoded
 431 /// into libsyntax itself.
 432 #[cfg(rustdoc)]
 433 mod builtin {
 434
 435     /// Unconditionally causes compilation to fail with the given error message when encountered.
 436     ///
 437     /// This macro should be used when a crate uses a conditional compilation strategy to provide
 438     /// better error messages for erroneous conditions. It's the compiler-level form of [`panic!`],
 439     /// which emits an error at *runtime*, rather than during compilation.
 440     ///
 441     /// # Examples
 442     ///
 443     /// Two such examples are macros and `#[cfg]` environments.
 444     ///
 445     /// Emit better compiler error if a macro is passed invalid values. Without the final branch,
 446     /// the compiler would still emit an error, but the error's message would not mention the two
 447     /// valid values.
 448     ///
 449     /// ```compile_fail
 450     /// macro_rules! give_me_foo_or_bar {
 451     ///     (foo) => {};
 452     ///     (bar) => {};
 453     ///     ($x:ident) => {
 454     ///         compile_error!("This macro only accepts `foo` or `bar`");
 455     ///     }
 456     /// }
 457     ///
 458     /// give_me_foo_or_bar!(neither);
 459     /// // ^ will fail at compile time with message "This macro only accepts `foo` or `bar`"
 460     /// ```
 461     ///
 462     /// Emit compiler error if one of a number of features isn't available.
 463     ///
 464     /// ```compile_fail
 465     /// #[cfg(not(any(feature = "foo", feature = "bar")))]
 466     /// compile_error!("Either feature \"foo\" or \"bar\" must be enabled for this crate.")
 467     /// ```
 468     ///
 469     /// [`panic!`]: ../std/macro.panic.html
 470     #[stable(feature = "compile_error_macro", since = "1.20.0")]
 471     #[rustc_doc_only_macro]
 472     macro_rules! compile_error {
 473         ($msg:expr) => ({ /* compiler built-in */ });
 474         ($msg:expr,) => ({ /* compiler built-in */ });
 475     }
 476
 477     /// The core macro for formatted string creation & output.
 478     ///
 479     /// This macro functions by taking a formatting string literal containing
 480     /// `{}` for each additional argument passed.  `format_args!` prepares the
 481     /// additional parameters to ensure the output can be interpreted as a string
 482     /// and canonicalizes the arguments into a single type.  Any value that implements
 483     /// the [`Display`] trait can be passed to `format_args!`, as can any
 484     /// [`Debug`] implementation be passed to a `{:?}` within the formatting string.
 485     ///
 486     /// This macro produces a value of type [`fmt::Arguments`]. This value can be
 487     /// passed to the macros within [`std::fmt`] for performing useful redirection.
 488     /// All other formatting macros ([`format!`], [`write!`], [`println!`], etc) are
 489     /// proxied through this one.  `format_args!`, unlike its derived macros, avoids
 490     /// heap allocations.
 491     ///
 492     /// You can use the [`fmt::Arguments`] value that `format_args!` returns
 493     /// in `Debug` and `Display` contexts as seen below. The example also shows
 494     /// that `Debug` and `Display` format to the same thing: the interpolated
 495     /// format string in `format_args!`.
 496     ///
 497     /// ```rust
 498     /// let debug = format!("{:?}", format_args!("{} foo {:?}", 1, 2));
 499     /// let display = format!("{}", format_args!("{} foo {:?}", 1, 2));
 500     /// assert_eq!("1 foo 2", display);
 501     /// assert_eq!(display, debug);
 502     /// ```
 503     ///
 504     /// For more information, see the documentation in [`std::fmt`].
 505     ///
 506     /// [`Display`]: ../std/fmt/trait.Display.html
 507     /// [`Debug`]: ../std/fmt/trait.Debug.html
 508     /// [`fmt::Arguments`]: ../std/fmt/struct.Arguments.html
 509     /// [`std::fmt`]: ../std/fmt/index.html
 510     /// [`format!`]: ../std/macro.format.html
 511     /// [`write!`]: ../std/macro.write.html
 512     /// [`println!`]: ../std/macro.println.html
 513     ///
 514     /// # Examples
 515     ///
 516     /// ```
 517     /// use std::fmt;
 518     ///
 519     /// let s = fmt::format(format_args!("hello {}", "world"));
 520     /// assert_eq!(s, format!("hello {}", "world"));
 521     /// ```
 522     #[stable(feature = "rust1", since = "1.0.0")]
 523     #[rustc_doc_only_macro]
 524     macro_rules! format_args {
 525         ($fmt:expr) => ({ /* compiler built-in */ });
 526         ($fmt:expr, $($args:tt)*) => ({ /* compiler built-in */ });
 527     }
 528
 529     /// Inspect an environment variable at compile time.
 530     ///
 531     /// This macro will expand to the value of the named environment variable at
 532     /// compile time, yielding an expression of type `&'static str`.
 533     ///
 534     /// If the environment variable is not defined, then a compilation error
 535     /// will be emitted. To not emit a compile error, use the [`option_env!`]
 536     /// macro instead.
 537     ///
 538     /// [`option_env!`]: ../std/macro.option_env.html
 539     ///
 540     /// # Examples
 541     ///
 542     /// ```
 543     /// let path: &'static str = env!("PATH");
 544     /// println!("the $PATH variable at the time of compiling was: {}", path);
 545     /// ```
 546     ///
 547     /// You can customize the error message by passing a string as the second
 548     /// parameter:
 549     ///
 550     /// ```compile_fail
 551     /// let doc: &'static str = env!("documentation", "what's that?!");
 552     /// ```
 553     ///
 554     /// If the `documentation` environment variable is not defined, you'll get
 555     /// the following error:
 556     ///
 557     /// ```text
 558     /// error: what's that?!
 559     /// ```
 560     #[stable(feature = "rust1", since = "1.0.0")]
 561     #[rustc_doc_only_macro]
 562     macro_rules! env {
 563         ($name:expr) => ({ /* compiler built-in */ });
 564         ($name:expr,) => ({ /* compiler built-in */ });
 565     }
 566
 567     /// Optionally inspect an environment variable at compile time.
 568     ///
 569     /// If the named environment variable is present at compile time, this will
 570     /// expand into an expression of type `Option<&'static str>` whose value is
 571     /// `Some` of the value of the environment variable. If the environment
 572     /// variable is not present, then this will expand to `None`.  See
 573     /// [`Option<T>`][option] for more information on this type.
 574     ///
 575     /// A compile time error is never emitted when using this macro regardless
 576     /// of whether the environment variable is present or not.
 577     ///
 578     /// [option]: ../std/option/enum.Option.html
 579     ///
 580     /// # Examples
 581     ///
 582     /// ```
 583     /// let key: Option<&'static str> = option_env!("SECRET_KEY");
 584     /// println!("the secret key might be: {:?}", key);
 585     /// ```
 586     #[stable(feature = "rust1", since = "1.0.0")]
 587     #[rustc_doc_only_macro]
 588     macro_rules! option_env {
 589         ($name:expr) => ({ /* compiler built-in */ });
 590         ($name:expr,) => ({ /* compiler built-in */ });
 591     }
 592
 593     /// Concatenate identifiers into one identifier.
 594     ///
 595     /// This macro takes any number of comma-separated identifiers, and
 596     /// concatenates them all into one, yielding an expression which is a new
 597     /// identifier. Note that hygiene makes it such that this macro cannot
 598     /// capture local variables. Also, as a general rule, macros are only
 599     /// allowed in item, statement or expression position. That means while
 600     /// you may use this macro for referring to existing variables, functions or
 601     /// modules etc, you cannot define a new one with it.
 602     ///
 603     /// # Examples
 604     ///
 605     /// ```
 606     /// #![feature(concat_idents)]
 607     ///
 608     /// # fn main() {
 609     /// fn foobar() -> u32 { 23 }
 610     ///
 611     /// let f = concat_idents!(foo, bar);
 612     /// println!("{}", f());
 613     ///
 614     /// // fn concat_idents!(new, fun, name) { } // not usable in this way!
 615     /// # }
 616     /// ```
 617     #[unstable(feature = "concat_idents_macro", issue = "29599")]
 618     #[rustc_doc_only_macro]
 619     macro_rules! concat_idents {
 620         ($($e:ident),+) => ({ /* compiler built-in */ });
 621         ($($e:ident,)+) => ({ /* compiler built-in */ });
 622     }
 623
 624     /// Concatenates literals into a static string slice.
 625     ///
 626     /// This macro takes any number of comma-separated literals, yielding an
 627     /// expression of type `&'static str` which represents all of the literals
 628     /// concatenated left-to-right.
 629     ///
 630     /// Integer and floating point literals are stringified in order to be
 631     /// concatenated.
 632     ///
 633     /// # Examples
 634     ///
 635     /// ```
 636     /// let s = concat!("test", 10, 'b', true);
 637     /// assert_eq!(s, "test10btrue");
 638     /// ```
 639     #[stable(feature = "rust1", since = "1.0.0")]
 640     #[rustc_doc_only_macro]
 641     macro_rules! concat {
 642         ($($e:expr),*) => ({ /* compiler built-in */ });
 643         ($($e:expr,)*) => ({ /* compiler built-in */ });
 644     }
 645
 646     /// A macro which expands to the line number on which it was invoked.
 647     ///
 648     /// With [`column!`] and [`file!`], these macros provide debugging information for
 649     /// developers about the location within the source.
 650     ///
 651     /// The expanded expression has type `u32` and is 1-based, so the first line
 652     /// in each file evaluates to 1, the second to 2, etc. This is consistent
 653     /// with error messages by common compilers or popular editors.
 654     /// The returned line is *not necessarily* the line of the `line!` invocation itself,
 655     /// but rather the first macro invocation leading up to the invocation
 656     /// of the `line!` macro.
 657     ///
 658     /// [`column!`]: macro.column.html
 659     /// [`file!`]: macro.file.html
 660     ///
 661     /// # Examples
 662     ///
 663     /// ```
 664     /// let current_line = line!();
 665     /// println!("defined on line: {}", current_line);
 666     /// ```
 667     #[stable(feature = "rust1", since = "1.0.0")]
 668     #[rustc_doc_only_macro]
 669     macro_rules! line { () => ({ /* compiler built-in */ }) }
 670
 671     /// A macro which expands to the column number on which it was invoked.
 672     ///
 673     /// With [`line!`] and [`file!`], these macros provide debugging information for
 674     /// developers about the location within the source.
 675     ///
 676     /// The expanded expression has type `u32` and is 1-based, so the first column
 677     /// in each line evaluates to 1, the second to 2, etc. This is consistent
 678     /// with error messages by common compilers or popular editors.
 679     /// The returned column is *not necessarily* the line of the `column!` invocation itself,
 680     /// but rather the first macro invocation leading up to the invocation
 681     /// of the `column!` macro.
 682     ///
 683     /// [`line!`]: macro.line.html
 684     /// [`file!`]: macro.file.html
 685     ///
 686     /// # Examples
 687     ///
 688     /// ```
 689     /// let current_col = column!();
 690     /// println!("defined on column: {}", current_col);
 691     /// ```
 692     #[stable(feature = "rust1", since = "1.0.0")]
 693     #[rustc_doc_only_macro]
 694     macro_rules! column { () => ({ /* compiler built-in */ }) }
 695
 696     /// A macro which expands to the file name from which it was invoked.
 697     ///
 698     /// With [`line!`] and [`column!`], these macros provide debugging information for
 699     /// developers about the location within the source.
 700     ///
 701     ///
 702     /// The expanded expression has type `&'static str`, and the returned file
 703     /// is not the invocation of the `file!` macro itself, but rather the
 704     /// first macro invocation leading up to the invocation of the `file!`
 705     /// macro.
 706     ///
 707     /// [`line!`]: macro.line.html
 708     /// [`column!`]: macro.column.html
 709     ///
 710     /// # Examples
 711     ///
 712     /// ```
 713     /// let this_file = file!();
 714     /// println!("defined in file: {}", this_file);
 715     /// ```
 716     #[stable(feature = "rust1", since = "1.0.0")]
 717     #[rustc_doc_only_macro]
 718     macro_rules! file { () => ({ /* compiler built-in */ }) }
 719
 720     /// A macro which stringifies its arguments.
 721     ///
 722     /// This macro will yield an expression of type `&'static str` which is the
 723     /// stringification of all the tokens passed to the macro. No restrictions
 724     /// are placed on the syntax of the macro invocation itself.
 725     ///
 726     /// Note that the expanded results of the input tokens may change in the
 727     /// future. You should be careful if you rely on the output.
 728     ///
 729     /// # Examples
 730     ///
 731     /// ```
 732     /// let one_plus_one = stringify!(1 + 1);
 733     /// assert_eq!(one_plus_one, "1 + 1");
 734     /// ```
 735     #[stable(feature = "rust1", since = "1.0.0")]
 736     #[rustc_doc_only_macro]
 737     macro_rules! stringify { ($($t:tt)*) => ({ /* compiler built-in */ }) }
 738
 739     /// Includes a utf8-encoded file as a string.
 740     ///
 741     /// The file is located relative to the current file. (similarly to how
 742     /// modules are found)
 743     ///
 744     /// This macro will yield an expression of type `&'static str` which is the
 745     /// contents of the file.
 746     ///
 747     /// # Examples
 748     ///
 749     /// Assume there are two files in the same directory with the following
 750     /// contents:
 751     ///
 752     /// File 'spanish.in':
 753     ///
 754     /// ```text
 755     /// adiós
 756     /// ```
 757     ///
 758     /// File 'main.rs':
 759     ///
 760     /// ```ignore (cannot-doctest-external-file-dependency)
 761     /// fn main() {
 762     ///     let my_str = include_str!("spanish.in");
 763     ///     assert_eq!(my_str, "adiós\n");
 764     ///     print!("{}", my_str);
 765     /// }
 766     /// ```
 767     ///
 768     /// Compiling 'main.rs' and running the resulting binary will print "adiós".
 769     #[stable(feature = "rust1", since = "1.0.0")]
 770     #[rustc_doc_only_macro]
 771     macro_rules! include_str {
 772         ($file:expr) => ({ /* compiler built-in */ });
 773         ($file:expr,) => ({ /* compiler built-in */ });
 774     }
 775
 776     /// Includes a file as a reference to a byte array.
 777     ///
 778     /// The file is located relative to the current file. (similarly to how
 779     /// modules are found)
 780     ///
 781     /// This macro will yield an expression of type `&'static [u8; N]` which is
 782     /// the contents of the file.
 783     ///
 784     /// # Examples
 785     ///
 786     /// Assume there are two files in the same directory with the following
 787     /// contents:
 788     ///
 789     /// File 'spanish.in':
 790     ///
 791     /// ```text
 792     /// adiós
 793     /// ```
 794     ///
 795     /// File 'main.rs':
 796     ///
 797     /// ```ignore (cannot-doctest-external-file-dependency)
 798     /// fn main() {
 799     ///     let bytes = include_bytes!("spanish.in");
 800     ///     assert_eq!(bytes, b"adi\xc3\xb3s\n");
 801     ///     print!("{}", String::from_utf8_lossy(bytes));
 802     /// }
 803     /// ```
 804     ///
 805     /// Compiling 'main.rs' and running the resulting binary will print "adiós".
 806     #[stable(feature = "rust1", since = "1.0.0")]
 807     #[rustc_doc_only_macro]
 808     macro_rules! include_bytes {
 809         ($file:expr) => ({ /* compiler built-in */ });
 810         ($file:expr,) => ({ /* compiler built-in */ });
 811     }
 812
 813     /// Expands to a string that represents the current module path.
 814     ///
 815     /// The current module path can be thought of as the hierarchy of modules
 816     /// leading back up to the crate root. The first component of the path
 817     /// returned is the name of the crate currently being compiled.
 818     ///
 819     /// # Examples
 820     ///
 821     /// ```
 822     /// mod test {
 823     ///     pub fn foo() {
 824     ///         assert!(module_path!().ends_with("test"));
 825     ///     }
 826     /// }
 827     ///
 828     /// test::foo();
 829     /// ```
 830     #[stable(feature = "rust1", since = "1.0.0")]
 831     #[rustc_doc_only_macro]
 832     macro_rules! module_path { () => ({ /* compiler built-in */ }) }
 833
 834     /// Boolean evaluation of configuration flags, at compile-time.
 835     ///
 836     /// In addition to the `#[cfg]` attribute, this macro is provided to allow
 837     /// boolean expression evaluation of configuration flags. This frequently
 838     /// leads to less duplicated code.
 839     ///
 840     /// The syntax given to this macro is the same syntax as [the `cfg`
 841     /// attribute](../book/first-edition/conditional-compilation.html).
 842     ///
 843     /// # Examples
 844     ///
 845     /// ```
 846     /// let my_directory = if cfg!(windows) {
 847     ///     "windows-specific-directory"
 848     /// } else {
 849     ///     "unix-directory"
 850     /// };
 851     /// ```
 852     #[stable(feature = "rust1", since = "1.0.0")]
 853     #[rustc_doc_only_macro]
 854     macro_rules! cfg { ($($cfg:tt)*) => ({ /* compiler built-in */ }) }
 855
 856     /// Parse a file as an expression or an item according to the context.
 857     ///
 858     /// The file is located relative to the current file (similarly to how
 859     /// modules are found).
 860     ///
 861     /// Using this macro is often a bad idea, because if the file is
 862     /// parsed as an expression, it is going to be placed in the
 863     /// surrounding code unhygienically. This could result in variables
 864     /// or functions being different from what the file expected if
 865     /// there are variables or functions that have the same name in
 866     /// the current file.
 867     ///
 868     /// # Examples
 869     ///
 870     /// Assume there are two files in the same directory with the following
 871     /// contents:
 872     ///
 873     /// File 'monkeys.in':
 874     ///
 875     /// ```ignore (only-for-syntax-highlight)
 876     /// ['🙈', '🙊', '🙉']
 877     ///     .iter()
 878     ///     .cycle()
 879     ///     .take(6)
 880     ///     .collect::<String>()
 881     /// ```
 882     ///
 883     /// File 'main.rs':
 884     ///
 885     /// ```ignore (cannot-doctest-external-file-dependency)
 886     /// fn main() {
 887     ///     let my_string = include!("monkeys.in");
 888     ///     assert_eq!("🙈🙊🙉🙈🙊🙉", my_string);
 889     ///     println!("{}", my_string);
 890     /// }
 891     /// ```
 892     ///
 893     /// Compiling 'main.rs' and running the resulting binary will print
 894     /// "🙈🙊🙉🙈🙊🙉".
 895     #[stable(feature = "rust1", since = "1.0.0")]
 896     #[rustc_doc_only_macro]
 897     macro_rules! include {
 898         ($file:expr) => ({ /* compiler built-in */ });
 899         ($file:expr,) => ({ /* compiler built-in */ });
 900     }
 901
 902     /// Ensure that a boolean expression is `true` at runtime.
 903     ///
 904     /// This will invoke the [`panic!`] macro if the provided expression cannot be
 905     /// evaluated to `true` at runtime.
 906     ///
 907     /// # Uses
 908     ///
 909     /// Assertions are always checked in both debug and release builds, and cannot
 910     /// be disabled. See [`debug_assert!`] for assertions that are not enabled in
 911     /// release builds by default.
 912     ///
 913     /// Unsafe code relies on `assert!` to enforce run-time invariants that, if
 914     /// violated could lead to unsafety.
 915     ///
 916     /// Other use-cases of `assert!` include [testing] and enforcing run-time
 917     /// invariants in safe code (whose violation cannot result in unsafety).
 918     ///
 919     /// # Custom Messages
 920     ///
 921     /// This macro has a second form, where a custom panic message can
 922     /// be provided with or without arguments for formatting.  See [`std::fmt`]
 923     /// for syntax for this form.
 924     ///
 925     /// [`panic!`]: macro.panic.html
 926     /// [`debug_assert!`]: macro.debug_assert.html
 927     /// [testing]: ../book/second-edition/ch11-01-writing-tests.html#checking-results-with-the-assert-macro
 928     /// [`std::fmt`]: ../std/fmt/index.html
 929     ///
 930     /// # Examples
 931     ///
 932     /// ```
 933     /// // the panic message for these assertions is the stringified value of the
 934     /// // expression given.
 935     /// assert!(true);
 936     ///
 937     /// fn some_computation() -> bool { true } // a very simple function
 938     ///
 939     /// assert!(some_computation());
 940     ///
 941     /// // assert with a custom message
 942     /// let x = true;
 943     /// assert!(x, "x wasn't true!");
 944     ///
 945     /// let a = 3; let b = 27;
 946     /// assert!(a + b == 30, "a = {}, b = {}", a, b);
 947     /// ```
 948     #[stable(feature = "rust1", since = "1.0.0")]
 949     #[rustc_doc_only_macro]
 950     macro_rules! assert {
 951         ($cond:expr) => ({ /* compiler built-in */ });
 952         ($cond:expr,) => ({ /* compiler built-in */ });
 953         ($cond:expr, $($arg:tt)+) => ({ /* compiler built-in */ });
 954     }
 955 }
 956
 957 /// A macro for defining `#[cfg]` if-else statements.
 958 ///
 959 /// This is similar to the `if/elif` C preprocessor macro by allowing definition
 960 /// of a cascade of `#[cfg]` cases, emitting the implementation which matches
 961 /// first.
 962 ///
 963 /// This allows you to conveniently provide a long list `#[cfg]`'d blocks of code
 964 /// without having to rewrite each clause multiple times.
 965 macro_rules! cfg_if {
 966     ($(
 967         if #[cfg($($meta:meta),*)] { $($it:item)* }
 968     ) else * else {
 969         $($it2:item)*
 970     }) => {
 971         __cfg_if_items! {
 972             () ;
 973             $( ( ($($meta),*) ($($it)*) ), )*
 974             ( () ($($it2)*) ),
 975         }
 976     }
 977 }
 978
 979 macro_rules! __cfg_if_items {
 980     (($($not:meta,)*) ; ) => {};
 981     (($($not:meta,)*) ; ( ($($m:meta),*) ($($it:item)*) ), $($rest:tt)*) => {
 982         __cfg_if_apply! { cfg(all(not(any($($not),*)), $($m,)*)), $($it)* }
 983         __cfg_if_items! { ($($not,)* $($m,)*) ; $($rest)* }
 984     }
 985 }
 986
 987 macro_rules! __cfg_if_apply {
 988     ($m:meta, $($it:item)*) => {
 989         $(#[$m] $it)*
 990     }
 991 }