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(not(test))]
  38 #[macro_export]
  39 #[stable(feature = "rust1", since = "1.0.0")]
  40 #[allow_internal_unstable(box_syntax, liballoc_internals)]
  41 macro_rules! vec {
  42     () => (
  43         $crate::__rust_force_expr!($crate::vec::Vec::new())
  44     );
  45     ($elem:expr; $n:expr) => (
  46         $crate::__rust_force_expr!($crate::vec::from_elem($elem, $n))
  47     );
  48     ($($x:expr),+ $(,)?) => (
  49         $crate::__rust_force_expr!(<[_]>::into_vec(box [$($x),+]))
  50     );
  51 }
  52
  53 // HACK(japaric): with cfg(test) the inherent `[T]::into_vec` method, which is
  54 // required for this macro definition, is not available. Instead use the
  55 // `slice::into_vec`  function which is only available with cfg(test)
  56 // NB see the slice::hack module in slice.rs for more information
  57 #[cfg(test)]
  58 macro_rules! vec {
  59     () => (
  60         $crate::vec::Vec::new()
  61     );
  62     ($elem:expr; $n:expr) => (
  63         $crate::vec::from_elem($elem, $n)
  64     );
  65     ($($x:expr),*) => (
  66         $crate::slice::into_vec(box [$($x),*])
  67     );
  68     ($($x:expr,)*) => (vec![$($x),*])
  69 }
  70
  71 /// Creates a `String` using interpolation of runtime expressions.
  72 ///
  73 /// The first argument `format!` receives is a format string. This must be a string
  74 /// literal. The power of the formatting string is in the `{}`s contained.
  75 ///
  76 /// Additional parameters passed to `format!` replace the `{}`s within the
  77 /// formatting string in the order given unless named or positional parameters
  78 /// are used; see [`std::fmt`] for more information.
  79 ///
  80 /// A common use for `format!` is concatenation and interpolation of strings.
  81 /// The same convention is used with [`print!`] and [`write!`] macros,
  82 /// depending on the intended destination of the string.
  83 ///
  84 /// To convert a single value to a string, use the [`to_string`] method. This
  85 /// will use the [`Display`] formatting trait.
  86 ///
  87 /// [`std::fmt`]: ../std/fmt/index.html
  88 /// [`print!`]: ../std/macro.print.html
  89 /// [`write!`]: core::write
  90 /// [`to_string`]: crate::string::ToString
  91 /// [`Display`]: core::fmt::Display
  92 ///
  93 /// # Panics
  94 ///
  95 /// `format!` panics if a formatting trait implementation returns an error.
  96 /// This indicates an incorrect implementation
  97 /// since `fmt::Write for String` never returns an error itself.
  98 ///
  99 /// # Examples
 100 ///
 101 /// ```
 102 /// format!("test");
 103 /// format!("hello {}", "world!");
 104 /// format!("x = {}, y = {y}", 10, y = 30);
 105 /// ```
 106 #[macro_export]
 107 #[stable(feature = "rust1", since = "1.0.0")]
 108 #[cfg_attr(not(test), rustc_diagnostic_item = "format_macro")]
 109 macro_rules! format {
 110     ($($arg:tt)*) => {{
 111         let res = $crate::fmt::format($crate::__export::format_args!($($arg)*));
 112         res
 113     }}
 114 }
 115
 116 /// Force AST node to an expression to improve diagnostics in pattern position.
 117 #[doc(hidden)]
 118 #[macro_export]
 119 #[unstable(feature = "liballoc_internals", issue = "none", reason = "implementation detail")]
 120 macro_rules! __rust_force_expr {
 121     ($e:expr) => {
 122         $e
 123     };
 124 }