library/alloc/src/macros.rs

   1 /// Creates a [`Vec`] containing the arguments.
   2 ///
   3 /// `vec!` allows `Vec`s to be defined with the same syntax as array expressions.
   4 /// There are two forms of this macro:
   5 ///
   6 /// - Create a [`Vec`] containing a given list of elements:
   7 ///
   8 /// ```
   9 /// let v = vec![1, 2, 3];
  10 /// assert_eq!(v[0], 1);
  11 /// assert_eq!(v[1], 2);
  12 /// assert_eq!(v[2], 3);
  13 /// ```
  14 ///
  15 /// - Create a [`Vec`] from a given element and size:
  16 ///
  17 /// ```
  18 /// let v = vec![1; 3];
  19 /// assert_eq!(v, [1, 1, 1]);
  20 /// ```
  21 ///
  22 /// Note that unlike array expressions this syntax supports all elements
  23 /// which implement [`Clone`] and the number of elements doesn't have to be
  24 /// a constant.
  25 ///
  26 /// This will use `clone` to duplicate an expression, so one should be careful
  27 /// using this with types having a nonstandard `Clone` implementation. For
  28 /// example, `vec![Rc::new(1); 5]` will create a vector of five references
  29 /// to the same boxed integer value, not five references pointing to independently
  30 /// boxed integers.
  31 ///
  32 /// Also, note that `vec![expr; 0]` is allowed, and produces an empty vector.
  33 /// This will still evaluate `expr`, however, and immediately drop the resulting value, so
  34 /// be mindful of side effects.
  35 ///
  36 /// [`Vec`]: crate::vec::Vec
  37 #[cfg(all(not(no_global_oom_handling), not(test)))]
  38 #[macro_export]
  39 #[stable(feature = "rust1", since = "1.0.0")]
  40 #[rustc_diagnostic_item = "vec_macro"]
  41 #[allow_internal_unstable(rustc_attrs, liballoc_internals)]
  42 macro_rules! vec {
  43     () => (
  44         $crate::__rust_force_expr!($crate::vec::Vec::new())
  45     );
  46     ($elem:expr; $n:expr) => (
  47         $crate::__rust_force_expr!($crate::vec::from_elem($elem, $n))
  48     );
  49     ($($x:expr),+ $(,)?) => (
  50         $crate::__rust_force_expr!(<[_]>::into_vec(
  51             #[rustc_box]
  52             $crate::boxed::Box::new([$($x),+])
  53         ))
  54     );
  55 }
  56
  57 // HACK(japaric): with cfg(test) the inherent `[T]::into_vec` method, which is
  58 // required for this macro definition, is not available. Instead use the
  59 // `slice::into_vec`  function which is only available with cfg(test)
  60 // NB see the slice::hack module in slice.rs for more information
  61 #[cfg(all(not(no_global_oom_handling), test))]
  62 #[allow(unused_macro_rules)]
  63 macro_rules! vec {
  64     () => (
  65         $crate::vec::Vec::new()
  66     );
  67     ($elem:expr; $n:expr) => (
  68         $crate::vec::from_elem($elem, $n)
  69     );
  70     ($($x:expr),*) => (
  71         $crate::slice::into_vec($crate::boxed::Box::new([$($x),*]))
  72     );
  73     ($($x:expr,)*) => (vec![$($x),*])
  74 }
  75
  76 /// Creates a `String` using interpolation of runtime expressions.
  77 ///
  78 /// The first argument `format!` receives is a format string. This must be a string
  79 /// literal. The power of the formatting string is in the `{}`s contained.
  80 ///
  81 /// Additional parameters passed to `format!` replace the `{}`s within the
  82 /// formatting string in the order given unless named or positional parameters
  83 /// are used; see [`std::fmt`] for more information.
  84 ///
  85 /// A common use for `format!` is concatenation and interpolation of strings.
  86 /// The same convention is used with [`print!`] and [`write!`] macros,
  87 /// depending on the intended destination of the string.
  88 ///
  89 /// To convert a single value to a string, use the [`to_string`] method. This
  90 /// will use the [`Display`] formatting trait.
  91 ///
  92 /// [`std::fmt`]: ../std/fmt/index.html
  93 /// [`print!`]: ../std/macro.print.html
  94 /// [`write!`]: core::write
  95 /// [`to_string`]: crate::string::ToString
  96 /// [`Display`]: core::fmt::Display
  97 ///
  98 /// # Panics
  99 ///
 100 /// `format!` panics if a formatting trait implementation returns an error.
 101 /// This indicates an incorrect implementation
 102 /// since `fmt::Write for String` never returns an error itself.
 103 ///
 104 /// # Examples
 105 ///
 106 /// ```
 107 /// format!("test");
 108 /// format!("hello {}", "world!");
 109 /// format!("x = {}, y = {y}", 10, y = 30);
 110 /// let (x, y) = (1, 2);
 111 /// format!("{x} + {y} = 3");
 112 /// ```
 113 #[macro_export]
 114 #[stable(feature = "rust1", since = "1.0.0")]
 115 #[cfg_attr(not(test), rustc_diagnostic_item = "format_macro")]
 116 macro_rules! format {
 117     ($($arg:tt)*) => {{
 118         let res = $crate::fmt::format($crate::__export::format_args!($($arg)*));
 119         res
 120     }}
 121 }
 122
 123 /// Force AST node to an expression to improve diagnostics in pattern position.
 124 #[doc(hidden)]
 125 #[macro_export]
 126 #[unstable(feature = "liballoc_internals", issue = "none", reason = "implementation detail")]
 127 macro_rules! __rust_force_expr {
 128     ($e:expr) => {
 129         $e
 130     };
 131 }